redstrate/kawari
1
Fork 0
mirror of https://github.com/redstrate/Kawari.git synced 2025-05-12 14:47:46 +00:00
Code Activity

Note which run script to use in USAGE

Browse source
This commit is contained in:
Joshua Goins 2025-05-03 19:29:57 -04:00
parent 9a18202440
commit dbdc6ee99f
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
USAGE.md
View file

@ -34,6 +34,20 @@ 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`.
## Reverse proxy setup
Kawari isn't very useful unless it's addressable to a launcher. We provide a sample Caddyfile reverse proxy setup for this: