diff options
Diffstat (limited to 'Writerside/topics')
| -rw-r--r-- | Writerside/topics/config-file.md | 22 | ||||
| -rw-r--r-- | Writerside/topics/configuration.md | 2 | ||||
| -rw-r--r-- | Writerside/topics/gamerules.md | 15 | ||||
| -rw-r--r-- | Writerside/topics/introduction.md | 11 | ||||
| -rw-r--r-- | Writerside/topics/resource-pack.md | 49 | ||||
| -rw-r--r-- | Writerside/topics/usage.md | 7 |
6 files changed, 56 insertions, 50 deletions
diff --git a/Writerside/topics/config-file.md b/Writerside/topics/config-file.md index c70e347..56d4d94 100644 --- a/Writerside/topics/config-file.md +++ b/Writerside/topics/config-file.md @@ -1,6 +1,6 @@ # Config file -On top of the gamerules, you can edit a config file, named `molehunt.properties`. +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. @@ -11,8 +11,7 @@ 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} - +> {style=note} ## Editing the config file @@ -24,10 +23,10 @@ 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 - can be set on a single line -- A line starting with a `#` is a comment, and will not be counted be the mod. +- `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 @@ -42,6 +41,7 @@ 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 @@ -58,6 +58,7 @@ 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: + ```yaml # This is not a valid config file first_setting = 1 second_setting = 2 @@ -71,6 +72,7 @@ another_setting = 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 @@ -79,7 +81,7 @@ my_boolean = true my_boolean = false ``` -Every numerical value should be integers: there are no decimal values in this mod. +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 @@ -87,11 +89,11 @@ And you should not put the unit after the value (do not put `50 blocks`, but onl ## Default configuration -Here is the default configuration that is automatically generated. Every setting +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. +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 diff --git a/Writerside/topics/configuration.md b/Writerside/topics/configuration.md index a258e4f..456b982 100644 --- a/Writerside/topics/configuration.md +++ b/Writerside/topics/configuration.md @@ -1,7 +1,7 @@ # Configuration _Almost_ everything in the mod can be modified. You can change the mod's behavior by -changing custom gamerules or editing a config file. +changing custom gamerules or editing a config file. 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 index 54d9290..939388e 100644 --- a/Writerside/topics/gamerules.md +++ b/Writerside/topics/gamerules.md @@ -1,11 +1,11 @@ # Gamerules -To change the mods behavior, you can change your world's gamerules. Every gamerule added +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=tip} +> {style=tip} Here's a list of all the Molehunt gamerules. @@ -15,16 +15,16 @@ Here's a list of all the Molehunt gamerules. - `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`). +- `moleCount`: the absolute mole amount. Overwrites `molePercentage`. To disable + this setting, set it to `-1` (default: `-1`). - `foodOnStart`: give food on start ### 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} +> {style=note} - `showNametags`: players' nametags are shown (default: `false`). - `showSkins`: players' custom skin is visible. Setting this to false will @@ -40,6 +40,7 @@ Here's a list of all the Molehunt gamerules. - `initialWorldSize`: the world size when starting the game (default: `600 blocks`). - `finalWorldSize`: the target world size on the end of the game (default: `100 blocks`). -- `borderMovingStartingTimeOffsetMinutes`: the time before the world borders start to move in minutes (default: `10 minutes`). +- `borderMovingStartingTimeOffsetMinutes`: the time before the world borders start to move in minutes (default: + `10 minutes`). > Setting this to a value greater than `gameDuration` will make the borders never move. {style=note} diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index e2ef02c..cb32630 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -2,7 +2,8 @@ [Molehunt](https://modrinth.com/mod/molehunt-mod) is a mod creating the Molehunt game in Minecraft. You can watch this [video](https://www.youtube.com/watch?v=NJBjQ8T_1cc) to understand what it is. -If you are speaking French, I made this [30 seconds video](https://cdn.anhgelus.world/molehunt-presentation.mp4) explaining the concept. +If you are speaking French, I made this [30 seconds video](https://cdn.anhgelus.world/molehunt-presentation.mp4) +explaining the concept. ## Installation @@ -11,10 +12,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. -> If you use Simple Voice Chat, make sure to disable private groups, +> If you use Simple Voice Chat, make sure to disable private groups, > as they would ruin the immersion. -{style=tip} +> {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 +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). diff --git a/Writerside/topics/resource-pack.md b/Writerside/topics/resource-pack.md index b3bbf86..9b83906 100644 --- a/Writerside/topics/resource-pack.md +++ b/Writerside/topics/resource-pack.md @@ -3,14 +3,13 @@ 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 +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} - +> {style=tip} ## First steps @@ -19,6 +18,7 @@ inside of this folder, create a file named `pack.mcmeta`. This file is very impo 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": { @@ -28,15 +28,16 @@ Now, edit the `pack.mcmeta` file with your favorite text editor, and write the f } ``` -> 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 +> 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} +> {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 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 @@ -46,18 +47,18 @@ You file tree you look like that: > 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} - +> {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 +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 +and put it inside a `textures` folder, inside the `molehunt` folder. It should look like that: + ``` ... ๐ assets @@ -68,27 +69,27 @@ look like that: 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! +it to another language, you can! > Note that french is already supported by default, so no need to translate > to it. -{style=tip} +> {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} +> {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 @@ -98,15 +99,16 @@ Finally, your file structure should look like that: โโโ ๐ 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 +[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 pack should look like this: + ``` ๐ MyAwesomeResourcePack โโโ ๐ pack.mcmeta @@ -121,21 +123,20 @@ If you followed every step of this tutorial, the final resource pack should look โโโ etc. ``` -To install it on your client, simply put your awesome resource pack in the `resourcepacks` folder +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} +> 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 { diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md index 46bc5fb..6cb1c64 100644 --- a/Writerside/topics/usage.md +++ b/Writerside/topics/usage.md @@ -5,23 +5,24 @@ To start a game, execute `/molehunt start` (you must be OP). 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 -some 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). - ## Player commands The mod also provide a few commands for every player. If you forgot your role during the game, you can use `/molehunt role` This command will also provide you with some additional information : + - For survivors, it will give the mole count; - For moles and spectators, it will give the list of all 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 +use `/molehunt timer hide`. If you want to see it again, use `/molehunt timer show`. |