diff options
Diffstat (limited to 'Writerside/topics')
| -rw-r--r-- | Writerside/topics/config-file.md | 3 | ||||
| -rw-r--r-- | Writerside/topics/configuration.md | 110 | ||||
| -rw-r--r-- | Writerside/topics/gamerules.md | 40 | ||||
| -rw-r--r-- | Writerside/topics/resource-pack.md | 3 |
4 files changed, 50 insertions, 106 deletions
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 3f10fa1..a258e4f 100644 --- a/Writerside/topics/configuration.md +++ b/Writerside/topics/configuration.md @@ -1,109 +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`). - -### Misc -- Enable portals (for the nether, the end and the end gateway) : `enable_portals` (or `enablePortals`). - -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 - -# Enable portals (nether, end, end gateway) -# Default: false -enable_portals = false -``` +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 |
