From 3d2a85d3d36894b5bee0e2ff4dfce98c108db934 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 00:24:31 +0200 Subject: docs: change usage and configuration pages order --- Writerside/md.tree | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Writerside/md.tree b/Writerside/md.tree index d77dee5..f705954 100644 --- a/Writerside/md.tree +++ b/Writerside/md.tree @@ -7,6 +7,6 @@ start-page="introduction.md"> - + \ No newline at end of file -- cgit v1.2.3 From 7085c16ad3b4bec73306b8c24e079b98984cae90 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(-) 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 ad9c9c1714dd5750dab3e25da6f04b3c1eb43e85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 00:57:08 +0200 Subject: docs: change configuration page --- Writerside/md.tree | 6 ++- Writerside/topics/config-file.md | 3 ++ Writerside/topics/configuration.md | 103 ++----------------------------------- Writerside/topics/gamerules.md | 40 ++++++++++++++ Writerside/topics/resource-pack.md | 3 ++ 5 files changed, 55 insertions(+), 100 deletions(-) create mode 100644 Writerside/topics/config-file.md create mode 100644 Writerside/topics/gamerules.md create mode 100644 Writerside/topics/resource-pack.md diff --git a/Writerside/md.tree b/Writerside/md.tree index f705954..acd9d57 100644 --- a/Writerside/md.tree +++ b/Writerside/md.tree @@ -8,5 +8,9 @@ - + + + + + \ No newline at end of file diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md new file mode 100644 index 0000000..221f27f --- /dev/null +++ b/Writerside/topics/config-file.md @@ -0,0 +1,3 @@ +# Config file + +🚧 WIP 🚧 \ No newline at end of file diff --git a/Writerside/topics/configuration.md b/Writerside/topics/configuration.md index 41c4ff4..a258e4f 100644 --- a/Writerside/topics/configuration.md +++ b/Writerside/topics/configuration.md @@ -1,102 +1,7 @@ # Configuration -The mod has two configurations. -The first one modifies the settings of the current world. -The second one modifies the default settings of all your worlds. +_Almost_ everything in the mod can be modified. You can change the mod's behavior by +changing custom gamerules or editing a config file. -## Common concept - -### Molehunt game configuration : -- Game's duration: `game_duration` (or `gameDuration`). -Sets the game's duration in minutes (default: 90). -- Percentage of mole: `mole_percentage` (or `molePercentage`). -Sets the percentage of mole (default: 25). -- Number of mole: `mole_count` (or `moleCount`). -Sets the number of mole (default: -1). -If you want to use the percentage of mole instead, set this value to -1. - -### Client-side settings (applies to all players) : -- Enable players' nametag: `show_nametags` (or `showNametags`). -Players' nametag is visible (default: false). -- Enable players' skin: `show_skins` (or `showSkins`). -Players' skin is visible (default: false). -- Enable tab: `show_tab` (or `showTab`). -Tab can be used (default: false). - -### World-border settings : -- World border size when starting the game : `initial_world_size` (or `initialWorldSize`). -- Target border size on the end of the game : `final_world_size` (or `finalWorldSize`). -- Time before moving the borders : `border_moving_starting_time_offset` (or `borderMovingStartingTimeOffsetMinutes`). - -Every clientside rules (nametag, skin and tab) are only used by the client during a game. -Before and after the game, they are not used. - -## Configuration per world - -All settings can be modified via gamerules. - -Every gamerule related to this mod starts with the prefix `molehunt:`. - -## Modifying default configuration - -> These settings do not override the configuration per world! -{style="note"} - -A configuration file is available inside the `config` folder. -This is `molehunt.properties`. - -### Default configuration - -```ini -# Molehunt mod configuration file -# To regenerate the default configuration, delete, move or rename this file. - -# Game settings - -# The duration of a molehunt game, in minutes. -# Default: 90 minutes (1 hour 30 minutes). -game_duration = 90 - -# Mole percentage. -# For example, a mole percentage of 25% will get 1 mole every 4 players. -# Default: 25 %. -mole_percentage = 25 - -# Mole count (absolute). -# This setting will overwrite the mole_percentage setting. -# If set below 0, this setting is disabled. -# Default: -1. -mole_count = -1 - - -# Client-side settings (applies to all players) - -# Show nametags -# Default: false -show_nametags = false - -# Show skins -# Default: false -show_skins = false - -# Show tab -# Default: false -show_tab = false - - -# World border settings : - -# Initial world size (in blocks). -# Default: 200 blocks. -initial_world_size = 200 - -# Final world size (in blocks). -# Default: 50 blocks. -final_world_size = 50 - -# Shrinking starting offset (in minutes) -# The time before starting to shrink the world borders. -# If this value is greater than the game duration, borders will never shrink. -# Default: 10 minutes. -border_shrinking_starting_time_offset = 10 -``` +To change the mod's text and default skin, you can use a custom resource pack and set +it to be the default resource pack on your server. diff --git a/Writerside/topics/gamerules.md b/Writerside/topics/gamerules.md new file mode 100644 index 0000000..9090f28 --- /dev/null +++ b/Writerside/topics/gamerules.md @@ -0,0 +1,40 @@ +# 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=note} + +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`). + +### 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} diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md new file mode 100644 index 0000000..48076f3 --- /dev/null +++ b/Writerside/topics/resource-pack.md @@ -0,0 +1,3 @@ +# Making a cutom resource pack + +🚧 WIP 🚧 \ No newline at end of file -- cgit v1.2.3 From 44f1623ae1f1e3f4f69a5106f3eb5ff0419eb553 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 01:06:20 +0200 Subject: docs: change introduction --- Writerside/topics/gamerules.md | 2 +- Writerside/topics/introduction.md | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Writerside/topics/gamerules.md b/Writerside/topics/gamerules.md index 9090f28..5b37ec4 100644 --- a/Writerside/topics/gamerules.md +++ b/Writerside/topics/gamerules.md @@ -5,7 +5,7 @@ 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=note} +{style=tip} Here's a list of all the Molehunt gamerules. diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index f1fa63e..e2ef02c 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -11,4 +11,10 @@ Download the mod for your version. The mod requires [Fabric-API](https://modrinth.com/mod/fabric-api) to works. [Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat) is highly recommended. -The mod has to be installed on the server *and* on every client. +> If you use Simple Voice Chat, make sure to disable private groups, +> as they would ruin the immersion. +{style=tip} + +The mod has to be installed on the server *and* on every client. The mod is required +to be installed on clients for some client-side features (such as hiding nametags +or changing skins). -- cgit v1.2.3 From f868124e63d44467e1a656832b192e3ce54de911 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(-) 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