kawari/USAGE.md

Usage

Kawari is designed to be easy to run, and should be accessible to anyone who wants to run a local server for themselves.

Note: Persisted data (logins, characters, etc) are expected to not be 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

• Windows or Linux
• Copy of the game updated to the supported game version (see README)
• Oodle Network Compression (see below)

Getting Oodle

Get the latest release from this repository. You want the "gcc.zip" for Linux, and "msvc.zip" for Windows.

Download Artifact

Windows and Linux artifacts are built on every commit, under Github Actions. Place the oodle-network-shared.dll (Windows) or oodle-network-shared.so (Linux) in the same directory as the executables.

Building

Build Kawari with cargo build.

For the World server to function, Kawari needs to be built with --features oodle. Place the oodle-network-shared.lib (Windows) or oodle-network-shared.so (Linux) in a folder created by you named oodle before building.

Setup

Afterwards, create a config.yaml in the current directory. Currently the minimal config you need to run most services looks like this:

game_location: /path/to/gamedir/

More configuration options can be found in config.rs, such as changing the ports services run on. If you plan on just running it locally for yourself, you don't need to set anything else.

Kawari is made up of multiple executables, to simplify running we have a script to start all of them.

Windows

Double-click run.bat.

Linux

Run run.sh in a terminal.

Development

Run scripts/run.sh in a terminal.

Reverse proxy setup

Kawari isn't very useful unless it's addressable to a launcher, so we have to setup a "reverse proxy". We suggest using Caddy and we also have a configuration that works on most local setups. Run this in your operating system's terminal. If you're on Windows, point it to the Caddy .exe.

caddy run --config resources/Caddyfile

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

Logging in

Navigate to http://ffxiv.localhost, and register for an account. In order to actually log in, navigate to the Setup page and follow the instructions there. If you get an error in your web browser, ensure you're connecting via http:// and not https://.

Importing characters from retail

It's possible to import existing characters from the retail server using Auracite. Upload the backup ZIP on the account management page on the login server.

This feature is still a work-in-progress, and not all data is imported yet.

Chat commands

Debug commands

These special debug commands start with ! and are custom to Kawari.

• !setpos <x> <y> <z>: Teleport to the specified location
• !spawnnpc: Spawn a NPC for debugging
• !spawnmonster: Spawn a monster for debugging
• !playscene <id>: Plays an event. Only some events are supported for now:
  • Territory 181, Event 1245185 plays the Limsa opening sequence
  • Territory 182, Event 1245187 plays the Ul'dah opening sequence
  • Territory 183, Event 1245186 plays the Gridania opening sequence
• !spawnclone: Spawn a clone of yourself
• !classjob <id>: Changes to another class/job

GM commands

These GM commands are implemented in the FFXIV protocol, but only some of them are implemented.

• //gm teri <id>: Changes to the specified territory
• //gm weather <id>: Changes the weather
• //gm wireframe: Toggle wireframe rendering for the environment
• //gm item <id>: Gives yourself an item. This can only place a single item in the first page of your inventory currently.
• //gm lv <level>: Sets your current level