aboutsummaryrefslogtreecommitdiff
path: root/Writerside/topics
diff options
context:
space:
mode:
authorLéo Kosman <leo.kosman@proton.me>2024-08-25 00:24:48 +0200
committerLéo Kosman <leo.kosman@proton.me>2024-08-25 00:24:48 +0200
commit7085c16ad3b4bec73306b8c24e079b98984cae90 (patch)
tree7ccfe0577a3407a90bf783abcc9d95d4b4d0fa1e /Writerside/topics
parent3d2a85d3d36894b5bee0e2ff4dfce98c108db934 (diff)
docs: change usage page
Diffstat (limited to 'Writerside/topics')
-rw-r--r--Writerside/topics/usage.md29
1 files changed, 20 insertions, 9 deletions
diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md
index 2a02033..fa8da8d 100644
--- a/Writerside/topics/usage.md
+++ b/Writerside/topics/usage.md
@@ -1,13 +1,24 @@
-# Usage
+# Using the mod
-To start a game, execute `/molehunt start`.
-You must be OP.
+## Starting and stopping the game
-To stop a game, execute `/molehunt stop`.
-You must be OP.
-(They are already an automatic end if there is no more survivors or if the time is over.)
+To start a game, execute `/molehunt start` (you must be OP).
-To get the list of moles, use `/molehunt moles`.
-You must be a mole.
+The game stops automatically if one of these two condition is met :
+- Every alive player is a mole.
+- The timer has run out.
-To edit the timer above the hotbar, use `/molehunt timer show` to enable and `/molehunt timer hide` to disable.
+The game does not automatically end when every mole is dead to allow for
+funny moments. But if needed, you can stop the game early by using
+`/molehunt stop` (you must be OP).
+
+
+## Player commands
+
+The mod also provide a few commands for every player.
+
+For moles only, using `/molehunt moles` will give you the list of the moles.
+
+To some people, the timer above you hotbar could be annoying. To hide it,
+use `/molehunt timer hide`. If you want to see it again, use
+`/molehunt timer show`.