aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLéo Kosman <leo.kosman@proton.me>2024-08-24 23:33:03 +0200
committerLéo Kosman <leo.kosman@proton.me>2024-08-24 23:33:03 +0200
commit626400f987bb68d27fc46d53d63fc99922eae637 (patch)
tree5a43501b85f096ad9b6772a0e56c255a3d55fb9e
parentf00242079c8d5d2fccde794296ceb57ed2b9abaa (diff)
docs: document world border related settings
-rw-r--r--README.md29
-rw-r--r--Writerside/topics/configuration.md31
2 files changed, 42 insertions, 18 deletions
diff --git a/README.md b/README.md
index b3de1f7..e5338a9 100644
--- a/README.md
+++ b/README.md
@@ -16,33 +16,26 @@ Start the game with `/molehunt start` and enjoy!
Every player has the same skin.
-Players' nametag are disabled.
+Players' nametags are disabled.
-The tab, the chat and all message commands (`/msg`, `/tell` and `/w`) are disabled.
+The player list, the chat and the message commands (`/msg`, `/tell` and `/w`) are disabled.
Death and advancement messages are disabled.
-Stop the game when every innocent is dead or when the timer ended (one hour and half).
+World borders are set when starting and slowly shrink over the entire game.
+
+The mod stops the game when every innocent is dead or when the timer ended.
The moles can see the name of other moles with `/molehunt moles`.
-## Configuration
+_Almost_ everything in the mod can configured.
-You can configure every text line and the skin with a resource pack (for reference, check out
-[the default lang file](src/client/resources/assets/molehunt/lang/en_us.json) and [the default
-skin file](src/client/resources/assets/molehunt/textures/skin.png)).
+## Configuration
-Also, more server-side values can be changed in the configuration file, located in your server config directory.
-These settings will be applied by default to every new world.
-If you want to customize only one world, use the gamerules.
+To change most values, you can play with the gamerules added by the mod with the
+`/gamerule` command. Every gamerule introduced by the mod starts with `molehunt:`.
-Every setting can be modified in game with these gamerules:
-- `molehunt:gameDuration`
-- `molehunt:molePercentage`
-- `molehunt:moleCount`
-- `molehunt:showNametags`
-- `molehunt:showTab`
-- `molehunt:showSkins`
+To dive deeper into the configuration, [an online wiki is available](https://www.anhgelus.world/molehunt/configuration.html).
## Technologies
@@ -52,6 +45,6 @@ Every setting can be modified in game with these gamerules:
## Credits
-Creator of the skin used is unknown.
+Creator of the default skin used is unknown.
Thanks @leo-210 for the help!
diff --git a/Writerside/topics/configuration.md b/Writerside/topics/configuration.md
index e6fc92a..41c4ff4 100644
--- a/Writerside/topics/configuration.md
+++ b/Writerside/topics/configuration.md
@@ -6,6 +6,7 @@ The second one modifies the default settings of all your worlds.
## 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`).
@@ -13,6 +14,8 @@ 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`).
@@ -20,6 +23,11 @@ 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.
@@ -41,6 +49,9 @@ This is `molehunt.properties`.
```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).
@@ -57,6 +68,9 @@ mole_percentage = 25
# Default: -1.
mole_count = -1
+
+# Client-side settings (applies to all players)
+
# Show nametags
# Default: false
show_nametags = false
@@ -68,4 +82,21 @@ 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
```