diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf index 0eb922a41..20d2649af 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -3,15 +3,16 @@ ## Core-Config ## ## ## -# By changing the setting (accept-download) below to TRUE you are indicating that you have accepted mojang's EULA (https://account.mojang.com/documents/minecraft_eula), +# By changing the setting (accept-download) below to TRUE you are indicating that you have accepted Mojang's EULA (https://account.mojang.com/documents/minecraft_eula), # you confirm that you own a license to Minecraft (Java Edition), -# and you agree that BlueMap will download and use a minecraft client file (depending on the minecraft version) from mojangs servers (https://piston-meta.mojang.com/) for you. -# This file contains resources that belong to mojang and you must not redistribute it or do anything else that is not compliant with mojang's EULA. -# BlueMap uses resources in this file to generate the 3D models used for the map and texture them. (BlueMap will not work without those resources). +# and you agree that BlueMap will download and use a Minecraft client file (depending on the Minecraft version) from Mojang's servers (https://piston-meta.mojang.com/) for you. +# This file contains resources that belong to Mojang and you must not redistribute it or do anything else that is not compliant with Mojang's EULA. +# BlueMap uses resources in this file to generate the 3D models used for the map and texture them. Without these, BlueMap will not work. # ${timestamp} accept-download: false -# The folder where BlueMap saves data files it needs during runtime or to save (for example) the render progress file to resume it later. +# The folder where BlueMap saves data files it needs during runtime. +# For example, the render progress file, which is used to resume the render across restarts. # Default is "bluemap" data: "${data}" @@ -19,7 +20,7 @@ data: "${data}" # A higher value can improve the render speed, but could impact performance on the host machine. # This should be always below or equal to the number of available processor cores. # Zero or a negative value means the amount of available processor cores subtracted by the value. -# (So a value of -2 with 6 cores results in 4 render threads). +# For example, on a machine with 6 cores, a value of -2 would result in 4 render threads. # Default is 1 render-thread-count: ${render-thread-count} diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/maps/map.conf b/common/src/main/resources/de/bluecolored/bluemap/config/maps/map.conf index 0839fbc36..f51763d87 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/maps/map.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/maps/map.conf @@ -66,8 +66,8 @@ remove-caves-below-y: ${remove-caves-below-y} # Defaults to 10000 (disabled). cave-detection-ocean-floor: -5 -# With this value set to true, BlueMap also uses the block light value (additionally to the sky light) to "detect caves". -# (See: remove-caves-below-y). +# With this value set to true, BlueMap also uses the block light value (additionally to the sky light) to "detect caves" +# (see the option above: remove-caves-below-y). # Changing this value requires a re-render of the map. # Default is false cave-detection-uses-block-light: false diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf index d59a01367..c97568b46 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -60,7 +60,7 @@ skin-download: true # The amount of players that is needed to pause BlueMap's render threads. # If this amount of players or more is online, BlueMap will stop rendering map updates until enough players have logged off again. -# Setting this to 0 or -1 will disable this feature (BlueMap will not pause rendering). +# Setting this to 0 or -1 will disable this feature, which means BlueMap will not pause rendering. # Default is -1 player-render-limit: -1 diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/storages/file.conf b/common/src/main/resources/de/bluecolored/bluemap/config/storages/file.conf index 1de842e1b..ac876871d 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/storages/file.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/storages/file.conf @@ -5,7 +5,7 @@ # The storage-type of this storage. # Depending on this setting, different config entries are allowed/expected in this config file. -# Don't change this value! (If you want a different storage-type, check out the other example configs). +# Don't change this value! If you want a different storage-type, check out the other example configs. storage-type: file # The path to the folder on your file system where BlueMap will save the rendered map. diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/storages/sql.conf b/common/src/main/resources/de/bluecolored/bluemap/config/storages/sql.conf index 3a18a8366..e7a1ff7c5 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/storages/sql.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/storages/sql.conf @@ -5,7 +5,7 @@ # The storage-type of this storage. # Depending on this setting, different config entries are allowed/expected in this config file. -# Don't change this value! (If you want a different storage-type, check out the other example configs). +# Don't change this value! If you want a different storage-type, check out the other example configs. storage-type: sql # The JDBC-Connection URL that is used to connect to the database. @@ -28,14 +28,14 @@ max-connections: -1 # This can be used to load a custom JDBC-Driver from a .jar file. # E.g. if your runtime environment is not already providing the SQL-Driver you need, # you could download the MariaDB JDBC-Connector from https://mariadb.com/downloads/connectors/connectors-data-access/java8-connector/ -# (If you set this value, you HAVE TO set the correct driver-class name below). -# Place it in the './bluemap' folder and use is like this: +# If you set this value, you HAVE TO set the correct driver-class name below. +# Place it in the './bluemap' folder and use it like this: #driver-jar: "bluemap/mariadb-java-client-3.0.7.jar" # This is the driver-class that BlueMap will try to load and use. # Check the documentation of the driver you are using if you don't know this. # Leaving this commented out means that BlueMap automatically tries to find a suitable driver in your classpath. -# (If you added a custom driver-jar value above, you HAVE TO set the correct class name here). +# If you added a custom driver-jar value above, you HAVE TO set the correct class name here. #driver-class: "org.mariadb.jdbc.Driver" # The compression type that BlueMap will use to compress generated map data.