aboutsummaryrefslogtreecommitdiff
path: root/Writerside/topics/config-file.md
diff options
context:
space:
mode:
Diffstat (limited to 'Writerside/topics/config-file.md')
-rw-r--r--Writerside/topics/config-file.md22
1 files changed, 12 insertions, 10 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