1
Fork 0
mirror of https://github.com/redstrate/Kawari.git synced 2025-04-19 22:36:49 +00:00

Document config.json

This commit is contained in:
NotNite 2025-03-17 14:49:11 -04:00 committed by Joshua Goins
parent 10fc8e32ce
commit da69b40ca6

View file

@ -15,7 +15,21 @@ Kawari is designed to be easy to run, with the goal of being accessible to anyon
## Setup
Build Kawari with `cargo build`. Then run it with the helper script:
Build Kawari with `cargo build`. Afterwards, create a `config.json` in the current directory that looks like this:
```json
{
"worlds_open": false,
"login_open": false,
"supported_platforms": ["win32"],
"boot_patches_location": "/path/to/boot/patches",
"game_location": "/path/to/game"
}
```
All values in the config are optional, but some may be required for certain services to work correctly.
Finally, run Kawari with the helper script:
```shell
$ ./run.sh