aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLéo Kosman <leo.kosman@proton.me>2024-08-24 12:55:01 +0200
committerGitHub <noreply@github.com>2024-08-24 12:55:01 +0200
commit34dc864a495699f1311651c92111884653b42806 (patch)
treefcfe59c6d292f4c52d3c81cd51dd019b0e72b388 /README.md
parent1973cd58deb902e6df6a152b38e6585a0bf61a5e (diff)
parentd1d56e097d1aaa90358069370f454e65fc9dbbd5 (diff)
Merge pull request #4 from anhgelus/feat/config
[Feat] Config file
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 06c25bd..f739a69 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,24 @@ Stop the game when every innocent is dead or when the timer ended (one hour and
The moles can see the name of other moles with `/molehunt moles`.
+## Configuration
+
+You can configure every text line and the skin with a resource pack (for reference, check out
+[the default lang file](src/client/resources/assets/molehunt/lang/en_us.json) and [the default
+skin file](src/client/resources/assets/molehunt/textures/skin.png)).
+
+Also, more server-side values can be changed in the configuration file, located in your server config directory.
+These settings will be applied by default to every new world.
+If you want to customize only one world, use the gamerules.
+
+Every setting can be modified in game with these gamerules:
+- `molehunt:gameDuration`
+- `molehunt:molePercentage`
+- `molehunt:moleCount`
+- `molehunt:showNametags`
+- `molehunt:showTab`
+- `molehunt:showSkins`
+
## Technologies
- Java 21