From 44da0eb50a40e2d05b67123aafaddc1841c7f460 Mon Sep 17 00:00:00 2001
From: Sainan <63328889+Sainan@users.noreply.github.com>
Date: Wed, 16 Apr 2025 15:35:39 +0200
Subject: [PATCH] docs: some basic explanation of config.json &
 config.json.example

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index ef091058..e1ef957a 100644
--- 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.