From b48eaf2292b4192f557dfec06d86123a3c852deb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 00:24:48 +0200 Subject: docs: change usage page --- Writerside/topics/usage.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) (limited to 'Writerside/topics/usage.md') 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`. -- cgit v1.2.3 From 55aaf960c56cea5cccabf376040f6aabba811ca7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 01:14:25 +0200 Subject: docs: change "stop" into "end" --- Writerside/topics/usage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Writerside/topics/usage.md') diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md index fa8da8d..b6c7ec8 100644 --- a/Writerside/topics/usage.md +++ b/Writerside/topics/usage.md @@ -4,12 +4,12 @@ To start a game, execute `/molehunt start` (you must be OP). -The game stops automatically if one of these two condition is met : +The game ends automatically if one of these two condition is met : - Every alive player is a mole. - The timer has run out. 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 +some funny moments. But if needed, you can stop the game early by using `/molehunt stop` (you must be OP). -- cgit v1.2.3 From 35065c8809b0a5c173f38631b28a10d5511aefdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 22:40:17 +0200 Subject: docs: spectators can also use the `/molehunt moles` command. --- Writerside/topics/usage.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Writerside/topics/usage.md') diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md index b6c7ec8..2ebab75 100644 --- a/Writerside/topics/usage.md +++ b/Writerside/topics/usage.md @@ -17,7 +17,8 @@ some funny moments. But if needed, you can stop the game early by using The mod also provide a few commands for every player. -For moles only, using `/molehunt moles` will give you the list of the moles. +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 -- cgit v1.2.3 From 0c9c50f1aa14053bc22dd4032cb9b1e87aeac1e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Mon, 26 Aug 2024 13:52:06 +0200 Subject: docs: remove spaces before colons --- Writerside/topics/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Writerside/topics/usage.md') diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md index 2ebab75..1170ba8 100644 --- a/Writerside/topics/usage.md +++ b/Writerside/topics/usage.md @@ -4,7 +4,7 @@ To start a game, execute `/molehunt start` (you must be OP). -The game ends automatically if one of these two condition is met : +The game ends automatically if one of these two condition is met: - Every alive player is a mole. - The timer has run out. -- cgit v1.2.3