From da69b40ca62a1052888ed20199a27815f4ee073a Mon Sep 17 00:00:00 2001
From: NotNite <hi@notnite.com>
Date: Mon, 17 Mar 2025 14:49:11 -0400
Subject: [PATCH] Document config.json

---
 USAGE.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/USAGE.md b/USAGE.md
index 79fd262..e9ee6af 100644
--- a/USAGE.md
+++ b/USAGE.md
@@ -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