9fa6a230d6
While you can just drop the Oodle static library into /usr, I'm not a big fan of doing it, especially when the binary didn't come from my machine or package manager. You can set a RUSTFLAGS environment variable or cargo config file to specify a link path, but having the build script search there for you is easier. The docs now specify which variant of Oodle is required, since there are multiple. It also specifically mentions the static library, because I had some weird issues leaving the dynamic library in that folder, where the executables wouldn't start unless it could dynamically load the .so.
1.9 KiB
Usage
Kawari is designed to be easy to run, with the goal of being accessible to anyone who wants to run a local server for themselves.
Note: Persisted data (logins, characters, etc) is not stable or secure. Treat all data as disposable.
Copyright Notice
Kawari requires that you have an active subscription, and are in possession of a legitimate copy of the game. Kawari is not related or affiliated to SqEx, and by using it you are in explicit violation of the User Agreement (Limitation 2.4.)
Prerequisites
- Linux
- Copy of the game updated to the supported game version (see README)
- Oodle Network Compression (can be obtained from here, place static library (
.a) intooodledirectory)
Setup
Build Kawari with cargo build. Then run it with the helper script:
$ ./run.sh
Reverse proxy setup
Kawari is useless if it's not behind a domain or other address accessible to a launcher. Even something like Caddy is good enough, and we provide an example setup in the root of the repository.
# caddy run
Logging in
Astra is the only launcher known to work, and it requires compiling the unreleased master branch. If you don't know what any of that means, then wait for a new release of Astra before trying Kawari.
- Enable "Developer Settings" under "General".
- Under "Developer Settings", enter the addresses of your servers in the section indicated below. If you used the default Caddy setup, tapping the "Set to localhost" button will fill these fields for you with the correct addresses.
- In "Game Server" and "Game Server Port", set it to "127.0.0.1" and "7000" respectively. This is the address and port of your Lobby server.
Any username and password combination will work, as there is no actual login database yet. In the client, make sure to select the Aether data center.