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') 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 aaf054130989c269af52394251df1a0ca6415373 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/topics/config-file.md | 3 + Writerside/topics/configuration.md | 110 ++----------------------------------- Writerside/topics/gamerules.md | 40 ++++++++++++++ Writerside/topics/resource-pack.md | 3 + 4 files changed, 50 insertions(+), 106 deletions(-) create mode 100644 Writerside/topics/config-file.md create mode 100644 Writerside/topics/gamerules.md create mode 100644 Writerside/topics/resource-pack.md (limited to 'Writerside/topics') 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 -- cgit v1.2.3 From 4bdcab3243c8b24e7f16993215d6ac5193adb16a 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(-) (limited to 'Writerside/topics') 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 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') 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 2df45c639867b33f72802a3cde7ff709342101cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 21:19:25 +0200 Subject: docs: add `enablePortals` gamerule doc --- Writerside/topics/gamerules.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/gamerules.md b/Writerside/topics/gamerules.md index 5b37ec4..10c895d 100644 --- a/Writerside/topics/gamerules.md +++ b/Writerside/topics/gamerules.md @@ -4,7 +4,7 @@ To change the mods behavior, you can change your world's gamerules. Every gameru 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) +> [edit the configuration file](config-file.md). {style=tip} Here's a list of all the Molehunt gamerules. @@ -31,7 +31,11 @@ Here's a list of all the Molehunt gamerules. a custom resource pack](resource-pack.md) (default: `false`). - `showTab`: The server player list will be shown (default: `false`). -### World-border settings : +### Server-side settings : + +- `enablePortals`: enables all portals to other dimensions (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`). -- cgit v1.2.3 From e22e4e757958cd2270a7d441c3f3eea06e0b8980 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 21:46:29 +0200 Subject: docs: create the config file page --- Writerside/topics/config-file.md | 137 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 136 insertions(+), 1 deletion(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md index 221f27f..2419406 100644 --- a/Writerside/topics/config-file.md +++ b/Writerside/topics/config-file.md @@ -1,3 +1,138 @@ # Config file -🚧 WIP 🚧 \ No newline at end of file +On top of the gamerules, you can edit a config file, named `molehunt.properties`. +This file is automatically generated when starting a server with the mod installed. + +This file will set the default settings when creating a new world, but that's it. +You will still be able to change the gamerules. Editing this file is recommended +when you plan on having multiple molehunt games with the same settings but on +different worlds. + +> If you only want to change the settings on a single world, or don't want to change +> a lot, I would suggest [playing with the gamerules](gamerules.md) rather than the config +> file, as it is easier and directly in-game +{style=note} + + +## Editing the config file + +You can find the `molehunt.properties` file in your server's `config` folder. +If it is not present, make sure the mod is installed, and start your server. + +Every setting available in the config file reflects a gamerule (they have very +similar names). To know what each setting does, you can check [the gamerules documention](gamerules.md). + +The config syntax is very simple : +- `name_of_the_setting = value` to set a setting to a `value`. Only one setting + can be set on a single line +- A line starting with a `#` is a comment, and will not be counted be the mod. + + +## Troubleshooting the config file + +If you realise the config file isn't being applied correctly, check these potential +solutions before making an issue on GitHub. + +### Checking the file location + +Make sure the config file you're editing is located in your server's `config` directory, +and that the file's name is `molehunt.properties`. + +### Make sure the syntax is correct + +A comment line starts with a `#`, not with `//` nor with anything else. + +Also, you can only set one variable on one line. For exemple, this is incorrect : +```yaml +# This is not a valid config file +first_setting = 1 second_setting = 2 +# The value must also be on the same line as the setting name. This is incorrect : +another_setting = +3 +``` + +### Make sure the setting have the right value type + +A boolean value (one that can either be "on or off") can be set to `true` or `false`, +nothing else. +```yaml +# Good +my_boolean = true + +# Bad +my_boolean = false +``` + +Every numerical value should be integers: there are no decimal values in this mod. +And you should not put the unit after the value (do not put `50 blocks`, but only `50`). + +> If you have checked everything, and there's still a problem, don't hesitate to +> create a new issue on GitHub, **if no existing issue match you problem**. + +## Default configuration + +Here is the default configuration that is automatically generated. Every setting +is listed below. + +To regenerate the default configuration, you can rename, move or delete your +current config file, and then run the server with the mod installed. + +```yaml +# 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 + +# Moving starting time offset (in minutes) +# The time before starting to move the world borders. +# If this value is greater than the game duration, borders will never move. +# Default: 10 minutes. +border_moving_starting_time_offset = 10 + +# Other + +# Enable portals (nether, end, end gateway) +# Default: false +enable_portals = false +``` -- cgit v1.2.3 From 8bf4b866e444bad6bba899abaa345806c393605e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 21:47:36 +0200 Subject: docs: wrap line earlier to make the render look better --- Writerside/topics/config-file.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md index 2419406..745cc44 100644 --- a/Writerside/topics/config-file.md +++ b/Writerside/topics/config-file.md @@ -46,7 +46,8 @@ Also, you can only set one variable on one line. For exemple, this is incorrect ```yaml # This is not a valid config file first_setting = 1 second_setting = 2 -# The value must also be on the same line as the setting name. This is incorrect : +# The value must also be on the same line as the +#setting name. This is incorrect : another_setting = 3 ``` -- cgit v1.2.3 From 83bce2a4a909404de581ead99a80955dd07d1c59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 21:54:40 +0200 Subject: docs: add troubleshooting solution to config file --- Writerside/topics/config-file.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md index 745cc44..91288e2 100644 --- a/Writerside/topics/config-file.md +++ b/Writerside/topics/config-file.md @@ -20,7 +20,8 @@ You can find the `molehunt.properties` file in your server's `config` folder. If it is not present, make sure the mod is installed, and start your server. Every setting available in the config file reflects a gamerule (they have very -similar names). To know what each setting does, you can check [the gamerules documention](gamerules.md). +similar names, even though different). To know what each setting does, you can +check [the gamerules documention](gamerules.md). The config syntax is very simple : - `name_of_the_setting = value` to set a setting to a `value`. Only one setting @@ -38,6 +39,20 @@ solutions before making an issue on GitHub. Make sure the config file you're editing is located in your server's `config` directory, and that the file's name is `molehunt.properties`. +### Check that you use the config file's setting names, and not the gamerule names + +For example, to change the game duration in the config file : +```yaml +# Do this : +game_duration = 30 + +# And NOT this : +gameDurationMinutes = 30 +molehunt:GameDurationMinutes = 30 +``` + +You can see the list of all config file setting in [the default configuration file](#default-configuration). + ### Make sure the syntax is correct A comment line starts with a `#`, not with `//` nor with anything else. -- cgit v1.2.3 From eb78e7e772db656d703519cb2fa25a5a8f2cef82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Sun, 25 Aug 2024 22:38:34 +0200 Subject: docs: add resource pack page --- Writerside/topics/resource-pack.md | 166 ++++++++++++++++++++++++++++++++++++- 1 file changed, 165 insertions(+), 1 deletion(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index 48076f3..6ae8915 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -1,3 +1,167 @@ # Making a cutom resource pack -🚧 WIP 🚧 \ No newline at end of file +If you want to customize visual elements of the mod, you can create +your own custom resource pack. + +Doing so will enable you to change or translate every text line used by +the mod, and also change to default skin that is applied to all players +(if the [gamerule `showSkins`](gamerules.md#client-side-settings) is set to true). + +> After creating your resource pack, you can either force its use by setting it as +> the server's resource pack, or make it optional (it's purely visuals anyway!) +{style=tip} + + +## First steps + +First, create a folder with your resource pack name (it can be whatever you want!). Then, +inside of this folder, create a file named `pack.mcmeta`. This file is very important : it tells +the game that it is indeed a resource pack. + +Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following : +```json +{ + "pack": { + "description": "An awesome description for an awesome resource pack", + "pack_format": 34 + } +} +``` + +> Note that the `pack_format` used here (34) corresponds to minecraft version 1.21.x. If you +> are making the resource pack for another version, you can check which pack format to use +> [on the wiki](https://minecraft.wiki/w/Pack_format). +{style=note} + +You can now close the `pack.mcmeta` file. Now, inside your resource pack's main folder, +create a folder named `assets`, and inside it make another folder name `molehunt`. + +You file tree you look like that : +``` +πŸ“ MyAwesomeResourcePack +β”œβ”€β”€ πŸ“„ pack.mcmeta +└── πŸ“ assets + └── πŸ“ molehunt +``` + +> If you want, you can also add an icon to your resource pack : just add a png file named +> `pack.png` in your resource pack's main folder. +{style=tip} + + +## Adding a custom skin + +To add a custom skin, first you need to make one. You can either use +your own skin, or make a new one using a minecraft skin editor (there are +a lot online). + +Then grab your skin file (make sure it's a `.png` file!), name it `skin.png` +and put it inside a `textures` folder, inside the `molehunt` folder. It should +look like that : +``` +... +πŸ“ assets +└── πŸ“ molehunt + └── πŸ“ textures + └── πŸ“„ skin.png +``` + +Now everyone in the game will be wearing your custom skin! + + +## Changing the mod's text + +Finally, if the mod's text doesn't suit you, or if you want to translate +it to another language, you can! + +> Note that french is already supported by default, so no need to translate +> to it. +{style=tip} + +First, create a new folder in the `molehunt` folder named `lang`, then create +a `en_us.json` file. + +> If you want to target another language, name the file according to your language +> and region. For example : `fr_fr.json` for French in France. +{style=note} + +Now copy the content of the [default `en_us.json` file](#default-en-us-json-language-file) +in you language file, and start editing the lines you want to change! + +Finally, your file structure should look like that : +``` +... +πŸ“ assets +└── πŸ“ molehunt + └── πŸ“ lang + └── πŸ“„ en_us.json + └── πŸ“„ en_pt.json + └── etc. +``` +(You can have only one, or multiple language files, it doesn't matter) + +[Minecraft formatting codes](https://minecraft.wiki/w/Formatting_codes) are +supported in `titles` and `subtitles`. + + +## Final file tree, and installing your resource pack + +If you followed every step of this tutorial, the final resource apck should look like this : +``` +πŸ“ MyAwesomeResourcePack +β”œβ”€β”€ πŸ“„ pack.mcmeta +β”œβ”€β”€ πŸ“„ pack.png (optional) +└── πŸ“ assets + └── πŸ“ molehunt + β”œβ”€β”€ πŸ“ textures + β”‚ └── πŸ“„ skin.png + └── πŸ“ lang + └── πŸ“„ en_us.json + └── πŸ“„ en_pt.json + └── etc. +``` + +To install it on your client, simply put your awesome resource pack in the `resourcepacks` folder +of [your `.minecraft` folder](https://minecraft.wiki/w/.minecraft). + +If you want, you can zip it to make sharing it easier, but it is not required. + + +## Default `en_us.json` language file + +Here's the default `en_us.json` file. You can use it as a template to +customize the mod's text lines. + +> The weird `Β§` and the character after it corresponds to a minecraft +> formatting code. It can change the text's color and format. You can +> learn more [on the wiki](https://minecraft.wiki/w/Formatting_codes). +{style=tip} + +```json +{ + "commands.molehunt.stop.failed": "The Molehunt game has not been started yet.", + "commands.molehunt.timer.show": "Showing Molehunt timer.", + "commands.molehunt.timer.hide": "Hiding Molehunt timer.", + "commands.molehunt.moles.list": "List of moles:", + "commands.molehunt.moles.list.deny": "You can't see the list of moles.", + "commands.molehunt.stop.success": "The Molehunt game has been stopped.", + "molehunt.game.end.suspense.title": "Β§eAnd the winners are...", + "molehunt.game.end.winners.moles.title": "Β§cThe Moles!", + "molehunt.game.end.winners.survivors.title": "Β§aNot the Moles!", + "molehunt.game.end.winners.subtitle": "Β§6The Moles were", + "molehunt.game.start.suspense": "Β§eYou are...", + "molehunt.game.start.mole.title": "Β§cThe Mole!", + "molehunt.game.start.mole.subtitle": "Β§eGet the list of moles with Β§6/molehunt moles", + "molehunt.game.start.survivor.title": "Β§aNot the Mole!", + "molehunt.game.start.survivor.subtitle": "Β§eTry to survive and find out who's the mole!", + "gamerule.molehunt:gameDuration": "Molehunt: Duration of a game", + "gamerule.molehunt:molePercentage": "Molehunt: Percentage of Mole", + "gamerule.molehunt:moleCount": "Molehunt: Number of Mole", + "gamerule.molehunt:showNametags": "Molehunt: Show players' nametag", + "gamerule.molehunt:showTab": "Molehunt: Enable the tab", + "gamerule.molehunt:showSkins": "Molehunt: Show players' skin", + "gamerule.molehunt:initialWorldSize": "Molehunt: Initial world size", + "gamerule.molehunt:finalWorldSize": "Molehunt: Final world size", + "gamerule.molehunt:borderMovingStartingTimeOffsetMinutes": "Molehunt: Time before moving the borders" +} +``` -- 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') 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/config-file.md | 12 ++++++------ Writerside/topics/gamerules.md | 8 ++++---- Writerside/topics/resource-pack.md | 16 ++++++++-------- Writerside/topics/usage.md | 2 +- 4 files changed, 19 insertions(+), 19 deletions(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md index 91288e2..bbfbecd 100644 --- a/Writerside/topics/config-file.md +++ b/Writerside/topics/config-file.md @@ -23,7 +23,7 @@ Every setting available in the config file reflects a gamerule (they have very similar names, even though different). To know what each setting does, you can check [the gamerules documention](gamerules.md). -The config syntax is very simple : +The config syntax is very simple: - `name_of_the_setting = value` to set a setting to a `value`. Only one setting can be set on a single line - A line starting with a `#` is a comment, and will not be counted be the mod. @@ -41,12 +41,12 @@ and that the file's name is `molehunt.properties`. ### Check that you use the config file's setting names, and not the gamerule names -For example, to change the game duration in the config file : +For example, to change the game duration in the config file: ```yaml -# Do this : +# Do this: game_duration = 30 -# And NOT this : +# And NOT this: gameDurationMinutes = 30 molehunt:GameDurationMinutes = 30 ``` @@ -57,12 +57,12 @@ You can see the list of all config file setting in [the default configuration fi A comment line starts with a `#`, not with `//` nor with anything else. -Also, you can only set one variable on one line. For exemple, this is incorrect : +Also, you can only set one variable on one line. For exemple, this is incorrect: ```yaml # This is not a valid config file first_setting = 1 second_setting = 2 # The value must also be on the same line as the -#setting name. This is incorrect : +#setting name. This is incorrect: another_setting = 3 ``` diff --git a/Writerside/topics/gamerules.md b/Writerside/topics/gamerules.md index 10c895d..c838643 100644 --- a/Writerside/topics/gamerules.md +++ b/Writerside/topics/gamerules.md @@ -11,14 +11,14 @@ Here's a list of all the Molehunt gamerules. ## Molehunt gamerule list -### Molehunt game configuration : +### 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 : +### Client-side settings > These gamerules affect client-side features, but are still applied to all players. > @@ -31,11 +31,11 @@ Here's a list of all the Molehunt gamerules. a custom resource pack](resource-pack.md) (default: `false`). - `showTab`: The server player list will be shown (default: `false`). -### Server-side settings : +### Server-side settings - `enablePortals`: enables all portals to other dimensions (default: `false`). -#### World-border settings : +#### 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`). diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index 6ae8915..b71e44f 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -15,10 +15,10 @@ the mod, and also change to default skin that is applied to all players ## First steps First, create a folder with your resource pack name (it can be whatever you want!). Then, -inside of this folder, create a file named `pack.mcmeta`. This file is very important : it tells +inside of this folder, create a file named `pack.mcmeta`. This file is very important: it tells the game that it is indeed a resource pack. -Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following : +Now, edit the `pack.mcmeta` file with your favorite text editor, and write the following: ```json { "pack": { @@ -36,7 +36,7 @@ Now, edit the `pack.mcmeta` file with your favorite text editor, and write the f You can now close the `pack.mcmeta` file. Now, inside your resource pack's main folder, create a folder named `assets`, and inside it make another folder name `molehunt`. -You file tree you look like that : +You file tree you look like that: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta @@ -44,7 +44,7 @@ You file tree you look like that : └── πŸ“ molehunt ``` -> If you want, you can also add an icon to your resource pack : just add a png file named +> If you want, you can also add an icon to your resource pack: just add a png file named > `pack.png` in your resource pack's main folder. {style=tip} @@ -57,7 +57,7 @@ a lot online). Then grab your skin file (make sure it's a `.png` file!), name it `skin.png` and put it inside a `textures` folder, inside the `molehunt` folder. It should -look like that : +look like that: ``` ... πŸ“ assets @@ -82,13 +82,13 @@ First, create a new folder in the `molehunt` folder named `lang`, then create a `en_us.json` file. > If you want to target another language, name the file according to your language -> and region. For example : `fr_fr.json` for French in France. +> and region. For example: `fr_fr.json` for French in France. {style=note} Now copy the content of the [default `en_us.json` file](#default-en-us-json-language-file) in you language file, and start editing the lines you want to change! -Finally, your file structure should look like that : +Finally, your file structure should look like that: ``` ... πŸ“ assets @@ -106,7 +106,7 @@ supported in `titles` and `subtitles`. ## Final file tree, and installing your resource pack -If you followed every step of this tutorial, the final resource apck should look like this : +If you followed every step of this tutorial, the final resource apck should look like this: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta 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 From 7c844612883be1d9b04ed91726062364635eb73d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A9o=20Kosman?= Date: Mon, 26 Aug 2024 13:52:36 +0200 Subject: docs: typo --- Writerside/topics/resource-pack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Writerside/topics') diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index b71e44f..c2fd871 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -106,7 +106,7 @@ supported in `titles` and `subtitles`. ## Final file tree, and installing your resource pack -If you followed every step of this tutorial, the final resource apck should look like this: +If you followed every step of this tutorial, the final resource pack should look like this: ``` πŸ“ MyAwesomeResourcePack β”œβ”€β”€ πŸ“„ pack.mcmeta -- cgit v1.2.3