aboutsummaryrefslogtreecommitdiff
path: root/Writerside/topics/usage.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/usage.md
parentf77e4e616ca2d4c5f1c206dd15922ba0ba79d66c (diff)
parent7c844612883be1d9b04ed91726062364635eb73d (diff)
Merge pull request #10 from anhgelus/docs/improve-online-doc
[Docs] Improve online docs
Diffstat (limited to 'Writerside/topics/usage.md')
-rw-r--r--Writerside/topics/usage.md30
1 files changed, 21 insertions, 9 deletions
diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md
index 2a02033..1170ba8 100644
--- a/Writerside/topics/usage.md
+++ b/Writerside/topics/usage.md
@@ -1,13 +1,25 @@
-# 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 ends 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
+some 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 and spectating players 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`.