aboutsummaryrefslogtreecommitdiff
path: root/Writerside/topics/gamerules.md
diff options
context:
space:
mode:
authorWilliam Hergès <anhgelus.morhtuuzh@proton.me>2024-08-26 21:19:49 +0200
committerGitHub <noreply@github.com>2024-08-26 21:19:49 +0200
commitbddff4c489a91a5e374574be2af263cc63d9044b (patch)
tree39b6c429d4daece9c4a6dad93299bf8eb5b6c94b /Writerside/topics/gamerules.md
parentf77e4e616ca2d4c5f1c206dd15922ba0ba79d66c (diff)
parent7c844612883be1d9b04ed91726062364635eb73d (diff)
Merge pull request #10 from anhgelus/docs/improve-online-doc
[Docs] Improve online docs
Diffstat (limited to 'Writerside/topics/gamerules.md')
-rw-r--r--Writerside/topics/gamerules.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/Writerside/topics/gamerules.md b/Writerside/topics/gamerules.md
new file mode 100644
index 0000000..c838643
--- /dev/null
+++ b/Writerside/topics/gamerules.md
@@ -0,0 +1,44 @@
+# Gamerules
+
+To change the mods behavior, you can change your world's gamerules. Every gamerule added
+by this mod starts with the prefix `molehunt:`.
+
+> If plan on making multiple worlds, and don't want to set the gamerules each time,
+> [edit the configuration file](config-file.md).
+{style=tip}
+
+Here's a list of all the Molehunt gamerules.
+
+## Molehunt gamerule list
+
+### Molehunt game configuration
+
+- `gameDurationMinutes`: sets the game's duration in minutes (default: `90 minutes`).
+- `molePercentage`: sets the mole percentage among all players (default: `25 %`).
+- `moleCount`: the absolute mole amount. Overwrites `molePercentage`. To disable
+ this setting, set it to `-1` (default: `-1`).
+
+### Client-side settings
+
+> These gamerules affect client-side features, but are still applied to all players.
+>
+> Also, they will only be effective when the game starts.
+{style=note}
+
+- `showNametags`: players' nametags are shown (default: `false`).
+- `showSkins`: players' custom skin is visible. Setting this to false will
+ result in everyone having the same skin. This skin can be customized by [creating
+ a custom resource pack](resource-pack.md) (default: `false`).
+- `showTab`: The server player list will be shown (default: `false`).
+
+### Server-side settings
+
+- `enablePortals`: enables all portals to other dimensions (default: `false`).
+
+#### World-border settings
+
+- `initialWorldSize`: the world size when starting the game (default: `200 blocks`).
+- `finalWorldSize`: the target world size on the end of the game (default: `50 blocks`).
+- `borderMovingStartingTimeOffsetMinutes`: the time before the world borders start to move in minutes (default: `5 minutes`).
+ > Setting this to a value greater than `gameDuration` will make the borders never move.
+ {style=note}