From dbdc6ee99f9a9f9dc71c9170d51ab5165fd55648 Mon Sep 17 00:00:00 2001 From: Joshua Goins Date: Sat, 3 May 2025 19:29:57 -0400 Subject: [PATCH] Note which run script to use in USAGE --- USAGE.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/USAGE.md b/USAGE.md index 032450b..1172619 100644 --- a/USAGE.md +++ b/USAGE.md @@ -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: