redstrate/kawari
1
Fork 0
mirror of https://github.com/redstrate/Kawari.git synced 2025-05-01 02:47:45 +00:00
Code Activity
kawari/USAGE.md
NotNite aeb8516a82 Document magic domains, privileged port usage 
I ran into the issue with privileged ports myself. The link to the Caddy
website has an aside about how to use setcap or sudo, which should be
good enough.
2025-03-17 16:40:04 -04:00

2.2 KiB
Raw Blame History

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) into oodle directory)

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

This Caddyfile hosts several domains, most notably ffxiv.localhost, on port 80. If you get a "permission denied" error starting Caddy, you must either start Caddy with elevated privileges or set the CAP_NET_BIND_SERVICE capability. See here for more information on how to do this.

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.

  1. Enable "Developer Settings" under "General".
  2. 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.
  3. 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.