docs: some basic explanation of config.json & config.json.example

2025-04-16 15:35:39 +02:00 · 2025-04-16 15:35:39 +02:00 · 44da0eb50a
commit 44da0eb50a
parent deb652ab37
1 changed files with 2 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -10,6 +10,8 @@ To get an idea of what functionality you can expect to be missing [have a look t

 ## config.json

+SpaceNinjaServer requires a `config.json`. To set it up, you can copy the [config.json.example](config.json.example), which has most cheats disabled.
+
 - `logger.level` can be `fatal`, `error`, `warn`, `info`, `http`, `debug`, or `trace`.
 - `myIrcAddresses` can be used to point to an IRC server. If not provided, defaults to `[ myAddress ]`.
 - `worldState.lockTime` will lock the time provided in worldState if nonzero, e.g. `1743202800` for night in POE.