aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranhgelus <anhgelus.morhtuuzh@proton.me>2024-10-27 12:16:29 +0000
committeranhgelus <anhgelus.morhtuuzh@proton.me>2024-10-27 12:16:29 +0000
commit78596eabe1506c1e9b02635a70328e4f9bf19bc4 (patch)
treeade58450f0099530c6f1c083c06683db7e2c6de9
parentaf3f249345472d3379d267f8e35fd46ee88d9a13 (diff)
docs(info): add config in readme
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 21ed2e8..56903ac 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,22 @@ update automatically the compass.
`/manhunt reset-timer` resets all timers (useful after a server crash).
+## Config file
+
+You can config the time before the release of the hunters and the time between two compass' updates by modifying the config
+file `config/manhunt.json`.
+
+The default config file is:
+```json
+{
+ "secondsBeforeRelease": 30,
+ "updateCompassEach": 15
+}
+```
+
+- `secondsBeforeRelease` is the time before the release of the hunters
+- `updateCompassEach` is the time between two compass' updates (fewer means more updates)
+
## Technos
- Fabric