From 713085b5cc88890a931fe6feeedafdde4750c67e Mon Sep 17 00:00:00 2001 From: Nightowl Date: Mon, 24 Nov 2025 18:47:11 +0000 Subject: [PATCH 1/6] Fix config indentation to be consistent. --- .../de/bluecolored/bluemap/config/maps/map.conf | 10 +++++----- .../de/bluecolored/bluemap/config/plugin.conf | 2 +- .../de/bluecolored/bluemap/config/storages/sql.conf | 4 ++-- .../de/bluecolored/bluemap/config/webapp.conf | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) 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 25f9a1c89..3117e02d9 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 @@ -4,8 +4,8 @@ ## ## # The path to the save-folder of the world to render. -# (If this is not defined (commented out or removed), the map will be only registered to the web-server and the web-app -# but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else.) +# (If this is not defined (commented out or removed), the map will be only registered to the web-server and the web-app +# but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else.) world: "${world}" # The dimension of the world. Can be "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" @@ -151,9 +151,9 @@ storage: "file" # If this is set to true BlueMap will render Chunks even if there is no light-data! # This can be useful for example if some mod prevents light-data from being saved correctly. # However, this also has a few drawbacks: -# - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves") -# - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision) -# - Night-mode might not work correctly +# - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves") +# - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision) +# - Night-mode might not work correctly # Default is false ignore-missing-light-data: 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 fa9b27436..08e9b4596 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -11,7 +11,7 @@ live-player-markers: true # A list of gamemodes that will prevent a player from appearing on the map. # Possible values are: survival, creative, spectator, adventure hidden-game-modes: [ - "spectator" + "spectator" ] # If this is true, players that are vanished (by a plugin) will be hidden on the 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 e8776244e..cfc717078 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 @@ -16,8 +16,8 @@ connection-url: "jdbc:mysql://localhost:3306/bluemap?permitMysqlScheme" # You can set any additional (JDBC-Driver-specific) properties here # Usually that's your db-user and password connection-properties: { - user: "root", - password: "" + user: "root", + password: "" } # The maximum number of connections to the database that are allowed to be open at the same time. diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index 8032ef5ab..a6281e931 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -65,11 +65,11 @@ lowres-slider-min: 500 # Here you can add URLs to custom scripts (js) so they will be loaded by the webapp # You can place them somewhere in bluemap's webroot and add the (relative) link here scripts: [ - #"js/my-custom-script.js" + #"js/my-custom-script.js" ] # Here you can add URLs to custom styles (css) so they will be loaded by the webapp # You can place them somewhere in bluemap's webroot and add the (relative) link here styles: [ - #"css/my-custom-style.css" + #"css/my-custom-style.css" ] From b231517f84ad6e1ba26068f186490cc94f982ee1 Mon Sep 17 00:00:00 2001 From: Nightowl Date: Mon, 24 Nov 2025 20:18:10 +0000 Subject: [PATCH 2/6] Fix configs to use consistent wording. --- .../de/bluecolored/bluemap/config/core.conf | 2 +- .../bluecolored/bluemap/config/maps/map.conf | 8 +++---- .../de/bluecolored/bluemap/config/plugin.conf | 4 ++-- .../bluemap/config/storages/file.conf | 4 ++-- .../bluemap/config/storages/sql.conf | 14 ++++++------ .../de/bluecolored/bluemap/config/webapp.conf | 22 +++++++++---------- .../bluecolored/bluemap/config/webserver.conf | 6 ++--- 7 files changed, 30 insertions(+), 30 deletions(-) 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 7e6f8bf3f..9c9f7e73c 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -11,7 +11,7 @@ # ${timestamp} accept-download: false -# The folder where bluemap saves data-files it needs during runtime or to save e.g. the render-progress to resume it later. +# The folder where BlueMap saves data-files it needs during runtime or to save e.g. the render-progress to resume it later. # Default is "bluemap" data: "${data}" 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 3117e02d9..fc2a4d3e8 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 @@ -4,7 +4,7 @@ ## ## # The path to the save-folder of the world to render. -# (If this is not defined (commented out or removed), the map will be only registered to the web-server and the web-app +# (If this is not defined (commented out or removed), the map will be only registered to the webserver and the webapp # but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else.) world: "${world}" @@ -74,20 +74,20 @@ cave-detection-uses-block-light: false # The minimum "inhabitedTime" value that a chunk must have to be rendered. # The "inhabitedTime" value of a chunk refers to the cumulative number of ticks players have been near this chunk. -# If you set this to a value greater than 0, bluemap will only render chunks that players have visited already. +# If you set this to a value greater than 0, BlueMap will only render chunks that players have visited already. # Default is 0 min-inhabited-time: 0 # With the render-mask you can limit the map-render. # This can be used to render only a certain part of a world or ignore the nethers ceiling. -# If you change the render-mask, bluemap automatically tries to update the map, +# If you change the render-mask, BlueMap automatically tries to update the map, # including deleting map-tiles which are outside the new limits. # You can use "/bluemap fix-edges " to fix any remaining issues. # # Please check out the wiki for more detailed information on how to configure this: # https://bluemap.bluecolored.de/wiki/customization/Masks.html # -# Default is no mask, bluemap will render everything that exists. +# Default is no mask, BlueMap will render everything that exists. render-mask: [ { #min-x: -4000 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 08e9b4596..4391c3222 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -59,9 +59,9 @@ hide-different-world: false 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 +# -> 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 -> 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 ca685b91d..bd91efa7e 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 @@ -8,11 +8,11 @@ # 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 +# The path to the folder on your file-system where BlueMap will save the rendered map # The default is: "bluemap/web/maps" root: "${root}" -# The compression-type that bluemap will use to compress generated map-data. +# The compression-type that BlueMap will use to compress generated map-data. # Available compression-types are: # - gzip # - zstd 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 cfc717078..5cbbe90f5 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 @@ -9,8 +9,8 @@ storage-type: sql # The JDBC-Connection URL that is used to connect to the database. -# The format for this url is usually something like: jdbc:[driver]://[host]:[port]/[database] -# The exact format of the url is determined by the JDBC-Driver you are using. +# The format for this URL is usually something like: jdbc:[driver]://[host]:[port]/[database] +# The exact format of the URL is determined by the JDBC-Driver you are using. connection-url: "jdbc:mysql://localhost:3306/bluemap?permitMysqlScheme" # You can set any additional (JDBC-Driver-specific) properties here @@ -25,19 +25,19 @@ connection-properties: { # Default is: -1 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, +# 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/ # place it in the './bluemap' folder and use is 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. +# 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 means that bluemap automatically tries to find a suitable driver in your classpath. +# Leaving this commented means that BlueMap automatically tries to find a suitable driver in your classpath. # (If you added a custom driverJar 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. +# The compression-type that BlueMap will use to compress generated map-data. # Available compression-types are: # - gzip # - zstd diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index a6281e931..e3046cc3c 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -3,22 +3,22 @@ ## Webapp-Config ## ## ## -# With this setting you can disable the creation and updating of all web-app related files +# With this setting you can disable the creation and updating of all webapp related files # Default is true enabled: true -# The webroot where the web-application files will be created. +# The webroot where the webapp files will be created. # Usually this should be set to the same directory like in the webserver.conf! # Default is "bluemap/web" webroot: "${webroot}" -# Whether the settings.json of the webapp should be updated/synchronized with the current bluemap settings. -# If this is set to "false", bluemap will only add maps to the settings.json but never remove unknown ones or update other settings. -# Disabling this is for example useful if you are running multiple bluemap instances on the same webroot and don't want them to overwrite each others maps. +# Whether the settings.json of the webapp should be updated/synchronized with the current BlueMap settings. +# If this is set to "false", BlueMap will only add maps to the settings.json but never remove unknown ones or update other settings. +# Disabling this is for example useful if you are running multiple BlueMap instances on the same webroot and don't want them to overwrite each others maps. # Default is true update-settings-file: true -# If the web-application should use cookies to save the configurations of a user. +# If the webapp should use cookies to save the configurations of a user. # Default is true use-cookies: true @@ -27,7 +27,7 @@ use-cookies: true default-to-flat-view: false # The default map and camera-location where a user will start after opening the webapp. -# This is in form of the url-anchor: Open your map in a browser and look at the url, everything after the '#' is the value for this setting. +# This is in form of the URL-anchor: Open your map in a browser and look at the URL, everything after the '#' is the value for this setting. # Default is "no anchor" -> The camera will start with the topmost map and at that map's starting point. #start-location: "world:0:16:-32:390:0.1:0.19:0:0:perspective" @@ -54,22 +54,22 @@ lowres-slider-max: 7000 lowres-slider-default: 2000 lowres-slider-min: 500 -# Here you can specify an alternative base url from where all map data is loaded. +# Here you can specify an alternative base URL from where all map-data is loaded. # Default is "maps" #map-data-root: "https://cdn.my-domain.com/mapdata" -# Here you can specify an alternative base url from where all live data is loaded. +# Here you can specify an alternative base URL from where all live data is loaded. # Default is "maps" #live-data-root: "https://cdn.my-domain.com/livedata" # Here you can add URLs to custom scripts (js) so they will be loaded by the webapp -# You can place them somewhere in bluemap's webroot and add the (relative) link here +# You can place them somewhere in BlueMap's webroot and add the (relative) link here scripts: [ #"js/my-custom-script.js" ] # Here you can add URLs to custom styles (css) so they will be loaded by the webapp -# You can place them somewhere in bluemap's webroot and add the (relative) link here +# You can place them somewhere in BlueMap's webroot and add the (relative) link here styles: [ #"css/my-custom-style.css" ] diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf index 0c580328c..5842ce447 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf @@ -3,9 +3,9 @@ ## Webserver-Config ## ## ## -# With this setting you can disable the integrated web-server. +# With this setting you can disable the integrated webserver. # This is useful if you want to only render the map-data for later use, or if you setup your own webserver. -# Default is enabled +# Default is true enabled: true # The webroot that the server will host to the web. @@ -31,7 +31,7 @@ log: { append: false # The format of the webserver-acivity logs. - # The syntax is the java String formatting, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html + # The syntax is the Java String formatting syntax, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html # Possible Arguments: # 1 - the source address (ignoring any xff headers) # 2 - the source address (using the (leftmost) xff header if provided) From 90707c49b1b9ef1d13554b74e101c50b40bd2255 Mon Sep 17 00:00:00 2001 From: Nightowl Date: Mon, 24 Nov 2025 22:30:59 +0000 Subject: [PATCH 3/6] Improve config phrasing. --- .../de/bluecolored/bluemap/config/core.conf | 10 +++++----- .../de/bluecolored/bluemap/config/maps/map.conf | 14 +++++++------- .../de/bluecolored/bluemap/config/plugin.conf | 13 ++++++------- .../bluecolored/bluemap/config/storages/sql.conf | 5 +++-- .../de/bluecolored/bluemap/config/webapp.conf | 6 +++--- .../de/bluecolored/bluemap/config/webserver.conf | 2 +- 6 files changed, 25 insertions(+), 25 deletions(-) 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 9c9f7e73c..9885e662a 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -11,7 +11,7 @@ # ${timestamp} accept-download: false -# The folder where BlueMap saves data-files it needs during runtime or to save e.g. the render-progress to resume it later. +# The folder where BlueMap saves data-files it needs during runtime or to save (for example) the render-progress file to resume it later. # Default is "bluemap" data: "${data}" @@ -19,15 +19,15 @@ data: "${data}" # A higher value can improve 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-processes) +# (So a value of -2 with 6 cores results in 4 render threads) # Default is 1 render-thread-count: ${render-thread-count} -# Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world-directories. +# Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world directories. # Default is true scan-for-mod-resources: true ${metrics<< -# If this is true, BlueMap might send really basic metrics reports containing only the implementation-type and the version that is being used to https://metrics.bluecolored.de/bluemap/ +# If this is true, BlueMap might send really basic metric reports containing only the implementation-type and the version that is being used to https://metrics.bluecolored.de/bluemap/ # This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :) # An example report looks like this: {"implementation":"${implementation}","version":"${version}","mcVersion":"${mcVersion}"} # Default is true @@ -43,6 +43,6 @@ log: { #file: "${logfile-with-time}" # Whether the logger should append to an existing file, or overwrite it - # Default is false + # Default is false (overwrite) append: false } 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 fc2a4d3e8..22ba5468a 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 @@ -23,7 +23,7 @@ name: "${name}" # Default is 0 sorting: ${sorting} -# The position on the world where the map will be centered if you open it. +# The position in the world where the map will be centered on when you open it. # You can change this at any time. # Default is { x: 0, z: 0 } start-pos: { x: 0, z: 0 } @@ -39,13 +39,13 @@ sky-color: "${sky-color}" void-color: "${void-color}" # Defines the initial sky-light-strength the map will be set to when it is opened. -# 0 is no sky-light, 1 is fully lighted. +# 0 is no sky-light, 1 is fully lit up. # You can change this at any time. # Default is 1 sky-light: 1 # Defines the ambient light-strength that every block is receiving, regardless of the sunlight/blocklight. -# 0 is no ambient light, 1 is fully lighted. +# 0 is no ambient light, 1 is fully lit up. # You can change this at any time. # Default is 0 ambient-light: ${ambient-light} @@ -79,7 +79,7 @@ cave-detection-uses-block-light: false min-inhabited-time: 0 # With the render-mask you can limit the map-render. -# This can be used to render only a certain part of a world or ignore the nethers ceiling. +# This can be used to render only a certain part of a world or ignore the Nether's ceiling. # If you change the render-mask, BlueMap automatically tries to update the map, # including deleting map-tiles which are outside the new limits. # You can use "/bluemap fix-edges " to fix any remaining issues. @@ -98,7 +98,7 @@ render-mask: [ #max-y: 100 }${remove-nether-ceiling<< { - # this removes everything at and between y 90 and 127 (the nethers ceiling) + # this removes everything at and between y 90 and 127 (the Nether's ceiling) # structures above the bedrock-ceiling remain visible subtract: true min-y: 90 @@ -108,7 +108,7 @@ render-mask: [ # Using this, BlueMap pretends that every Block outside of the defined render-mask is AIR, # this means you can see the blocks where the world is cut (instead of having a see-through/xray view). -# This has only an effect if you set some render-mask above. +# This only has an effect if you set some render-mask above. # Changing this value requires a re-render of the map. # Default is true render-edges: true @@ -154,7 +154,7 @@ storage: "file" # - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves") # - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision) # - Night-mode might not work correctly -# Default is false +# Default is false (wait for light-data) ignore-missing-light-data: false # Here you can define any static marker-sets with markers that should be displayed on the map. 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 4391c3222..f3a902766 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -40,14 +40,14 @@ hide-below-block-light: 0 # Default is false hide-different-world: false -# The interval in seconds that the markers will be written to the map-storage. +# The interval in seconds at which the markers will be written to the map-storage. # This is useful if you can't create a live-connection between the server and the webapp # and the markers can only be updated via the map-storage. # 0 or lower means that the markers will never be written to the map-storage. # Default is 0 #write-markers-interval: 10 -# The interval in seconds that the players will be written to the map-storage. +# The interval in seconds at which the players will be written to the map-storage. # This is useful if you can't create a live-connection between the server and the webapp # and the players can only be updated via the map-storage. # 0 or lower means that the players will never be written to the map-storage. @@ -59,14 +59,13 @@ hide-different-world: false 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 +# 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) # Default is -1 player-render-limit: -1 -# The interval in minutes in which a full map-update will be triggered. -# This is ADDITIONALLY to the normal map-update process (in case that fails to detect any file-changes). +# The interval in minutes at which a full map-update will be triggered. +# This is IN ADDITION to the normal map-update process (in case that fails to detect any file-changes). # ! This DOESN'T re-render the entire map each time, it only checks if there are some changes that have not been rendered yet! # Default is 1440 (24 hours) full-update-interval: 1440 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 5cbbe90f5..83ec81209 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 @@ -28,13 +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: #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 means that BlueMap automatically tries to find a suitable driver in your classpath. -# (If you added a custom driverJar above, you HAVE TO set the correct class name here) +# 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) #driver-class: "org.mariadb.jdbc.Driver" # The compression-type that BlueMap will use to compress generated map-data. diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index e3046cc3c..681b66816 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -23,7 +23,7 @@ update-settings-file: true use-cookies: true # If the webapp will default to flat-view instead of perspective-view. -# Default is false +# Default is false (perspective-view) default-to-flat-view: false # The default map and camera-location where a user will start after opening the webapp. @@ -54,11 +54,11 @@ lowres-slider-max: 7000 lowres-slider-default: 2000 lowres-slider-min: 500 -# Here you can specify an alternative base URL from where all map-data is loaded. +# Here you can specify an alternative base URL where all of the map-data is loaded from. # Default is "maps" #map-data-root: "https://cdn.my-domain.com/mapdata" -# Here you can specify an alternative base URL from where all live data is loaded. +# Here you can specify an alternative base URL where all of the live data is loaded from. # Default is "maps" #live-data-root: "https://cdn.my-domain.com/livedata" diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf index 5842ce447..ac67700f0 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf @@ -27,7 +27,7 @@ log: { #file: "${logfile-with-time}" # Whether the logger should append to an existing file, or overwrite it - # Default is false + # Default is false (overwrite) append: false # The format of the webserver-acivity logs. From 6dc6eab1fe839efa274762bf47481f1950c3de1b Mon Sep 17 00:00:00 2001 From: Nightowl Date: Mon, 24 Nov 2025 23:53:54 +0000 Subject: [PATCH 4/6] Add missing config defaults (and example). --- .../de/bluecolored/bluemap/config/core.conf | 2 +- .../de/bluecolored/bluemap/config/webapp.conf | 1 + .../bluecolored/bluemap/config/webserver.conf | 20 +++++++++---------- 3 files changed, 12 insertions(+), 11 deletions(-) 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 9885e662a..c90e67c0f 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -43,6 +43,6 @@ log: { #file: "${logfile-with-time}" # Whether the logger should append to an existing file, or overwrite it - # Default is false (overwrite) + # Default is false (overwrite the file) append: false } diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index 681b66816..fa5095ac6 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -32,6 +32,7 @@ default-to-flat-view: false #start-location: "world:0:16:-32:390:0.1:0.19:0:0:perspective" # The minimum (closest) and maximum (furthest) distance (in blocks) that the camera can be from the ground +# Default is min:5 max:100000 min-zoom-distance: 5 max-zoom-distance: 100000 diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf index ac67700f0..7aba568b3 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf @@ -27,19 +27,19 @@ log: { #file: "${logfile-with-time}" # Whether the logger should append to an existing file, or overwrite it - # Default is false (overwrite) + # Default is false (overwrite the file) append: false # The format of the webserver-acivity logs. # The syntax is the Java String formatting syntax, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html - # Possible Arguments: - # 1 - the source address (ignoring any xff headers) - # 2 - the source address (using the (leftmost) xff header if provided) - # 3 - the http-method of the request - # 4 - the full request-address - # 5 - the protocol version of the request - # 6 - the status-code of the response - # 7 - the status-message of the response - # Default is "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" + # Possible Arguments: | Example output + # 1 - the source address (ignoring any xff headers) | 10.10.10.10 + # 2 - the source address (using the (leftmost) xff header if provided) | 88.66.44.22 + # 3 - the http-method of the request | GET + # 4 - the full request-address | /assets/file.png + # 5 - the protocol version of the request | HTTP/1.1 + # 6 - the status-code of the response | 200 + # 7 - the status-message of the response | OK + # Default is "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" | 10.10.10.10 "GET /assets/file.png HTTP/1.1" 200 OK format: "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" } From 4de50e30c19b06e46a1866c49f133aa858c2f2bd Mon Sep 17 00:00:00 2001 From: Nightowl Date: Wed, 26 Nov 2025 12:30:31 +0000 Subject: [PATCH 5/6] Add sentence punctuation to the configs. And some other stuff I forgot. --- .../de/bluecolored/bluemap/config/core.conf | 16 +++---- .../bluecolored/bluemap/config/maps/map.conf | 42 +++++++++---------- .../de/bluecolored/bluemap/config/plugin.conf | 16 +++---- .../bluemap/config/storages/file.conf | 4 +- .../bluemap/config/storages/sql.conf | 12 +++--- .../de/bluecolored/bluemap/config/webapp.conf | 20 ++++----- .../bluecolored/bluemap/config/webserver.conf | 28 ++++++------- 7 files changed, 69 insertions(+), 69 deletions(-) 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 c90e67c0f..bc53e7c41 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -4,10 +4,10 @@ ## ## # 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) +# 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.) +# 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). # ${timestamp} accept-download: false @@ -19,7 +19,7 @@ data: "${data}" # A higher value can improve 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) +# (So a value of -2 with 6 cores results in 4 render threads). # Default is 1 render-thread-count: ${render-thread-count} @@ -33,16 +33,16 @@ ${metrics<< # Default is true metrics: true >>} -# Config-section for debug-logging +# Config-section for debug-logging: log: { # The file where the debug-log will be written to. # Comment out to disable debug-logging completely. - # Java String formatting syntax can be used to add time, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html - # Default is no logging + # Java String formatting syntax can be used to add timestamps, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html + # Default is no logging. file: "${logfile}" #file: "${logfile-with-time}" - # Whether the logger should append to an existing file, or overwrite it - # Default is false (overwrite the file) + # Whether the logger should append to an existing file, or overwrite it. + # Default is false (overwrite the file). append: false } 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 22ba5468a..aff6a7d16 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 @@ -4,20 +4,20 @@ ## ## # The path to the save-folder of the world to render. -# (If this is not defined (commented out or removed), the map will be only registered to the webserver and the webapp -# but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else.) +# If this is not defined (commented out or removed), the map will be only registered to the webserver and the webapp +# but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else. world: "${world}" -# The dimension of the world. Can be "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end" +# The dimension of the world. Can be "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end", # or any dimension-key introduced by a mod or datapack. dimension: "${dimension}" -# The display-name of this map -> how this map will be named on the webapp. +# The display-name of this map (how this map will be named on the webapp). # You can change this at any time. # Default is the id of this map name: "${name}" -# A lower value makes the map sorted first (in lists and menus), a higher value makes it sorted later. +# A lower value makes the map appear first (in lists and menus), a higher value makes it appear later. # The value needs to be an integer but it can be negative. # You can change this at any time. # Default is 0 @@ -28,12 +28,12 @@ sorting: ${sorting} # Default is { x: 0, z: 0 } start-pos: { x: 0, z: 0 } -# The color of the sky as a hex-color +# The color of the sky as a hex-color. # You can change this at any time. # Default is "#7dabff" sky-color: "${sky-color}" -# The color of the void as a hex-color +# The color of the void as a hex-color. # You can change this at any time. # Default is "#000000" void-color: "${void-color}" @@ -51,23 +51,23 @@ sky-light: 1 ambient-light: ${ambient-light} # BlueMap tries to omit all blocks that are below this Y-level and are not visible from above-ground. -# More specific: Block-Faces that have a sunlight/skylight value of 0 are removed. +# More specifically, Block-Faces that have a sunlight/skylight value of 0 are removed. # This improves the performance of the map on slower devices by a lot, but might cause some blocks to disappear that should normally be visible. # Changing this value requires a re-render of the map. -# Set to a very high value to remove caves everywhere (e.g. 10000) -# Set to a very low value to remove nothing and render all caves (e.g. -10000) -# Default is 55 (slightly below water-level) +# Set to a very high value to remove caves everywhere (e.g. 10000). +# Set to a very low value to remove nothing and render all caves (e.g. -10000). +# Default is 55 (slightly below water-level). remove-caves-below-y: ${remove-caves-below-y} # This is the amount of blocks relative to the "ocean-floor" heightmap that the cave-detection will start at. # Everything above that (heightmap-relative) y-level will not be removed. # Comment or set to a very high value to disable using the ocean-floor heightmap for cave-detection. # Changing this value requires a re-render of the map. -# Defaults to 10000 (disabled) +# 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) +# (See: remove-caves-below-y). # Changing this value requires a re-render of the map. # Default is false cave-detection-uses-block-light: false @@ -75,7 +75,7 @@ cave-detection-uses-block-light: false # The minimum "inhabitedTime" value that a chunk must have to be rendered. # The "inhabitedTime" value of a chunk refers to the cumulative number of ticks players have been near this chunk. # If you set this to a value greater than 0, BlueMap will only render chunks that players have visited already. -# Default is 0 +# Default is 0 (all generated chunks). min-inhabited-time: 0 # With the render-mask you can limit the map-render. @@ -98,8 +98,8 @@ render-mask: [ #max-y: 100 }${remove-nether-ceiling<< { - # this removes everything at and between y 90 and 127 (the Nether's ceiling) - # structures above the bedrock-ceiling remain visible + # This removes everything at and between y 90 and 127 (the Nether's ceiling). + # Structures above the bedrock-ceiling remain visible. subtract: true min-y: 90 max-y: 127 @@ -114,7 +114,7 @@ render-mask: [ render-edges: true # The sun-light strength that blocks at map-edges will recieve if render-edges is enabled. -# Should be a value between 0 and 15 +# Should be a value between 0 and 15. # Default is 15 edge-light-strength: 8 @@ -151,10 +151,10 @@ storage: "file" # If this is set to true BlueMap will render Chunks even if there is no light-data! # This can be useful for example if some mod prevents light-data from being saved correctly. # However, this also has a few drawbacks: -# - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves") -# - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision) -# - Night-mode might not work correctly -# Default is false (wait for light-data) +# - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves"). +# - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision). +# - Night-mode might not work correctly. +# Default is false (wait for light-data). ignore-missing-light-data: false # Here you can define any static marker-sets with markers that should be displayed on the map. 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 f3a902766..6ffa51418 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -9,13 +9,13 @@ live-player-markers: true # A list of gamemodes that will prevent a player from appearing on the map. -# Possible values are: survival, creative, spectator, adventure +# Possible values are: survival, creative, spectator or adventure. hidden-game-modes: [ "spectator" ] # If this is true, players that are vanished (by a plugin) will be hidden on the map. -# (This only works with Spigot and Sponge based vanish-plugins) +# (This only works with Spigot and Sponge based vanish-plugins). # Default is true hide-vanished: true @@ -29,10 +29,10 @@ hide-sneaking: false # Hides the player if they are in a sky or block-light level below the given number. # BOTH values have to be below the threshold for the player to be hidden! -# E.g. if you set both to 1, then the player will be hidden on the map if they are in absolute darkness +# E.g. if you set both to 1, then the player will be hidden on the map if they are in absolute darkness. # Or, if you want players only be visible on the surface you set the sky-threshold to something between 1 and 15 -# and the block-threshold to 16 -# Default is 0 (don't hide the player) +# and the block-threshold to 16. +# Default is 0 (don't hide the player). hide-below-sky-light: 0 hide-below-block-light: 0 @@ -59,13 +59,13 @@ hide-different-world: false 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) +# 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). # Default is -1 player-render-limit: -1 # The interval in minutes at which a full map-update will be triggered. # This is IN ADDITION to the normal map-update process (in case that fails to detect any file-changes). # ! This DOESN'T re-render the entire map each time, it only checks if there are some changes that have not been rendered yet! -# Default is 1440 (24 hours) +# Default is 1440 (24 hours). full-update-interval: 1440 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 bd91efa7e..aa589b03f 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,10 +5,10 @@ # 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 +# The path to the folder on your file-system where BlueMap will save the rendered map. # The default is: "bluemap/web/maps" root: "${root}" 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 83ec81209..807799b28 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. @@ -13,8 +13,8 @@ storage-type: sql # The exact format of the URL is determined by the JDBC-Driver you are using. connection-url: "jdbc:mysql://localhost:3306/bluemap?permitMysqlScheme" -# You can set any additional (JDBC-Driver-specific) properties here -# Usually that's your db-user and password +# You can set any additional (JDBC-Driver-specific) properties here. +# Usually that's your db-user and password. connection-properties: { user: "root", password: "" @@ -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 is 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. diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index fa5095ac6..4bf46e52b 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -3,7 +3,7 @@ ## Webapp-Config ## ## ## -# With this setting you can disable the creation and updating of all webapp related files +# With this setting you can disable the creation and updating of all webapp related files. # Default is true enabled: true @@ -28,27 +28,27 @@ default-to-flat-view: false # The default map and camera-location where a user will start after opening the webapp. # This is in form of the URL-anchor: Open your map in a browser and look at the URL, everything after the '#' is the value for this setting. -# Default is "no anchor" -> The camera will start with the topmost map and at that map's starting point. +# Default is "no anchor" (The camera will start with the topmost map and at that map's starting point). #start-location: "world:0:16:-32:390:0.1:0.19:0:0:perspective" -# The minimum (closest) and maximum (furthest) distance (in blocks) that the camera can be from the ground +# The minimum (closest) and maximum (furthest) distance (in blocks) that the camera can be from the ground. # Default is min:5 max:100000 min-zoom-distance: 5 max-zoom-distance: 100000 -# The default value of the resolution (settings-menu) +# The default value of the resolution (settings-menu). # Possible values are: 0.5, 1, 2 # Default is 1 resolution-default: 1 -# The min, max and default values of the hires render-distance slider (settings-menu) +# The min, max and default values of the hires render-distance slider (settings-menu). # The values are in blocks. # Default is max:500 default:100 and min:0 hires-slider-max: 500 hires-slider-default: 100 hires-slider-min: 0 -# The min, max and default values of the lowres render-distance slider (settings-menu) +# The min, max and default values of the lowres render-distance slider (settings-menu). # The values are in blocks. # Default is max:7000 default:2000 and min:500 lowres-slider-max: 7000 @@ -63,14 +63,14 @@ lowres-slider-min: 500 # Default is "maps" #live-data-root: "https://cdn.my-domain.com/livedata" -# Here you can add URLs to custom scripts (js) so they will be loaded by the webapp -# You can place them somewhere in BlueMap's webroot and add the (relative) link here +# Here you can add URLs to custom scripts (js) so they will be loaded by the webapp. +# You can place them somewhere in BlueMap's webroot and add the (relative) link here. scripts: [ #"js/my-custom-script.js" ] -# Here you can add URLs to custom styles (css) so they will be loaded by the webapp -# You can place them somewhere in BlueMap's webroot and add the (relative) link here +# Here you can add URLs to custom styles (css) so they will be loaded by the webapp. +# You can place them somewhere in BlueMap's webroot and add the (relative) link here. styles: [ #"css/my-custom-style.css" ] diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf index 7aba568b3..89c283944 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf @@ -17,29 +17,29 @@ webroot: "${webroot}" # Default is 8100 port: 8100 -# Config-section for webserver-activity logging +# Config-section for webserver-activity logging: log: { # The file where all the webserver-activity will be logged to. # Comment out to disable the logging completely. - # Java String formatting syntax can be used to add time, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html - # Default is no logging + # Java String formatting syntax can be used to add timestamps, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html + # Default is no logging. file: "${logfile}" #file: "${logfile-with-time}" - # Whether the logger should append to an existing file, or overwrite it - # Default is false (overwrite the file) + # Whether the logger should append to an existing file, or overwrite it. + # Default is false (overwrite the file). append: false # The format of the webserver-acivity logs. # The syntax is the Java String formatting syntax, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html - # Possible Arguments: | Example output - # 1 - the source address (ignoring any xff headers) | 10.10.10.10 - # 2 - the source address (using the (leftmost) xff header if provided) | 88.66.44.22 - # 3 - the http-method of the request | GET - # 4 - the full request-address | /assets/file.png - # 5 - the protocol version of the request | HTTP/1.1 - # 6 - the status-code of the response | 200 - # 7 - the status-message of the response | OK - # Default is "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" | 10.10.10.10 "GET /assets/file.png HTTP/1.1" 200 OK + # Possible Arguments: | Example output + # 1 - the source address (ignoring any xff headers). | 10.10.10.10 + # 2 - the source address (using the (leftmost) xff header if provided). | 88.66.44.22 + # 3 - the http-method of the request. | GET + # 4 - the full request-address. | /assets/file.png + # 5 - the protocol version of the request. | HTTP/1.1 + # 6 - the status-code of the response. | 200 + # 7 - the status-message of the response. | OK + # Default is "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" | 10.10.10.10 "GET /assets/file.png HTTP/1.1" 200 OK format: "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" } From eb9b3b106d24a7aaf609f0e575ceb9221f426bbe Mon Sep 17 00:00:00 2001 From: Nightowl Date: Wed, 26 Nov 2025 12:46:07 +0000 Subject: [PATCH 6/6] Unhyphenate the config comments where not needed. --- .../de/bluecolored/bluemap/config/core.conf | 22 ++++---- .../bluecolored/bluemap/config/maps/map.conf | 52 +++++++++---------- .../de/bluecolored/bluemap/config/plugin.conf | 38 +++++++------- .../bluemap/config/storages/file.conf | 10 ++-- .../bluemap/config/storages/sql.conf | 14 ++--- .../de/bluecolored/bluemap/config/webapp.conf | 12 ++--- .../bluecolored/bluemap/config/webserver.conf | 16 +++--- 7 files changed, 82 insertions(+), 82 deletions(-) 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 bc53e7c41..0eb922a41 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/core.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/core.conf @@ -5,38 +5,38 @@ # 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. +# 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). +# 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). # ${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 or to save (for example) the render progress file to resume it later. # Default is "bluemap" data: "${data}" # This changes the amount of threads that BlueMap will use to render the maps. -# A higher value can improve 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. +# 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). # Default is 1 render-thread-count: ${render-thread-count} -# Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world directories. +# Controls whether BlueMap should try to find and load mod resources and datapacks from the server/world directories. # Default is true scan-for-mod-resources: true ${metrics<< -# If this is true, BlueMap might send really basic metric reports containing only the implementation-type and the version that is being used to https://metrics.bluecolored.de/bluemap/ +# If this is true, BlueMap might send really basic metric reports containing only the implementation type and the version that is being used to https://metrics.bluecolored.de/bluemap/ # This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :) # An example report looks like this: {"implementation":"${implementation}","version":"${version}","mcVersion":"${mcVersion}"} # Default is true metrics: true >>} -# Config-section for debug-logging: +# Config-section for debug logging: log: { - # The file where the debug-log will be written to. - # Comment out to disable debug-logging completely. + # The file where the debug log will be written to. + # Comment out to disable debug logging completely. # Java String formatting syntax can be used to add timestamps, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html # Default is no logging. file: "${logfile}" 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 aff6a7d16..0839fbc36 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 @@ -3,16 +3,16 @@ ## Map-Config ## ## ## -# The path to the save-folder of the world to render. +# The path to the save folder of the world to render. # If this is not defined (commented out or removed), the map will be only registered to the webserver and the webapp # but not rendered or loaded by BlueMap. This can be used to display a map that has been rendered somewhere else. world: "${world}" # The dimension of the world. Can be "minecraft:overworld", "minecraft:the_nether", "minecraft:the_end", -# or any dimension-key introduced by a mod or datapack. +# or any dimension key introduced by a mod or datapack. dimension: "${dimension}" -# The display-name of this map (how this map will be named on the webapp). +# The display name of this map (how this map will be named on the webapp). # You can change this at any time. # Default is the id of this map name: "${name}" @@ -38,20 +38,20 @@ sky-color: "${sky-color}" # Default is "#000000" void-color: "${void-color}" -# Defines the initial sky-light-strength the map will be set to when it is opened. -# 0 is no sky-light, 1 is fully lit up. +# Defines the initial sky light strength the map will be set to when it is opened. +# 0 is no sky light, 1 is fully lit up. # You can change this at any time. # Default is 1 sky-light: 1 -# Defines the ambient light-strength that every block is receiving, regardless of the sunlight/blocklight. +# Defines the ambient light strength that every block is receiving, regardless of the sunlight/blocklight. # 0 is no ambient light, 1 is fully lit up. # You can change this at any time. # Default is 0 ambient-light: ${ambient-light} -# BlueMap tries to omit all blocks that are below this Y-level and are not visible from above-ground. -# More specifically, Block-Faces that have a sunlight/skylight value of 0 are removed. +# BlueMap tries to omit all blocks that are below this Y-level and are not visible from above ground. +# More specifically, block faces that have a sunlight/skylight value of 0 are removed. # This improves the performance of the map on slower devices by a lot, but might cause some blocks to disappear that should normally be visible. # Changing this value requires a re-render of the map. # Set to a very high value to remove caves everywhere (e.g. 10000). @@ -59,14 +59,14 @@ ambient-light: ${ambient-light} # Default is 55 (slightly below water-level). remove-caves-below-y: ${remove-caves-below-y} -# This is the amount of blocks relative to the "ocean-floor" heightmap that the cave-detection will start at. -# Everything above that (heightmap-relative) y-level will not be removed. -# Comment or set to a very high value to disable using the ocean-floor heightmap for cave-detection. +# This is the amount of blocks relative to the "ocean floor" heightmap that the cave detection will start at. +# Everything above that (heightmap relative) y-level will not be removed. +# Comment or set to a very high value to disable using the ocean floor heightmap for cave detection. # Changing this value requires a re-render of the map. # 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". +# 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). # Changing this value requires a re-render of the map. # Default is false @@ -78,10 +78,10 @@ cave-detection-uses-block-light: false # Default is 0 (all generated chunks). min-inhabited-time: 0 -# With the render-mask you can limit the map-render. +# With the render-mask you can limit the map render. # This can be used to render only a certain part of a world or ignore the Nether's ceiling. # If you change the render-mask, BlueMap automatically tries to update the map, -# including deleting map-tiles which are outside the new limits. +# including deleting map tiles which are outside the new limits. # You can use "/bluemap fix-edges " to fix any remaining issues. # # Please check out the wiki for more detailed information on how to configure this: @@ -99,7 +99,7 @@ render-mask: [ }${remove-nether-ceiling<< { # This removes everything at and between y 90 and 127 (the Nether's ceiling). - # Structures above the bedrock-ceiling remain visible. + # Structures above the bedrock ceiling remain visible. subtract: true min-y: 90 max-y: 127 @@ -113,7 +113,7 @@ render-mask: [ # Default is true render-edges: true -# The sun-light strength that blocks at map-edges will recieve if render-edges is enabled. +# The sun-light strength that blocks at map edges will recieve if render-edges is enabled. # Should be a value between 0 and 15. # Default is 15 edge-light-strength: 8 @@ -124,7 +124,7 @@ edge-light-strength: 8 enable-perspective-view: true # Whether the flat (isometric, top-down) view will be enabled for this map. -# Having only flat-view enabled while disabling free-flight and perspective will speed up the render and reduce the maps storage-size. +# Having only flat-view enabled while disabling free-flight and perspective will speed up the render and reduce the maps storage size. # Default is true enable-flat-view: true @@ -134,8 +134,8 @@ enable-flat-view: true enable-free-flight-view: true # Whether the hires-layer will be enabled. -# Disabling this will speed up rendering and reduce the size of the map-files a lot. -# But you will not be able to see the full 3d-models if you zoom in on the map. +# Disabling this will speed up rendering and reduce the size of the map files a lot. +# But you will not be able to see the full 3D models if you zoom in on the map. # Changing this to false will not remove any existing tiles, existing tiles just won't get updated anymore. # Changing this to true will require a re-render of the map. # Default is true @@ -147,14 +147,14 @@ enable-hires: true # Default is "file" storage: "file" -# Normally BlueMap detects if a chunk has not yet generated it's light-data and omits rendering those chunks. -# If this is set to true BlueMap will render Chunks even if there is no light-data! -# This can be useful for example if some mod prevents light-data from being saved correctly. +# Normally BlueMap detects if a chunk has not yet generated it's light data and omits rendering those chunks. +# If this is set to true BlueMap will render Chunks even if there is no light data! +# This can be useful for example if some mod prevents light data from being saved correctly. # However, this also has a few drawbacks: -# - Cave rendering will always be enabled (BlueMap is using the sky-light data to detect "caves"). -# - Everything will be rendered fully lit (sky-light value of 15, looks similar to having night vision). -# - Night-mode might not work correctly. -# Default is false (wait for light-data). +# - Cave rendering will always be enabled (BlueMap is using the sky light data to detect "caves"). +# - Everything will be rendered fully lit (sky light value of 15, looks similar to having night vision). +# - Night mode might not work correctly. +# Default is false (wait for light data). ignore-missing-light-data: false # Here you can define any static marker-sets with markers that should be displayed on the map. 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 6ffa51418..d59a01367 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/plugin.conf @@ -3,7 +3,7 @@ ## Plugin-Config ## ## ## -# If the server should send player-positions to the webapp. +# If the server should send player positions to the webapp. # This only works if the integrated webserver is enabled. # Default is true live-player-markers: true @@ -15,7 +15,7 @@ hidden-game-modes: [ ] # If this is true, players that are vanished (by a plugin) will be hidden on the map. -# (This only works with Spigot and Sponge based vanish-plugins). +# (This only works with Spigot and Sponge based vanish plugins). # Default is true hide-vanished: true @@ -27,45 +27,45 @@ hide-invisible: true # Default is false hide-sneaking: false -# Hides the player if they are in a sky or block-light level below the given number. +# Hides the player if they are in a sky (or block) light level below the given number. # BOTH values have to be below the threshold for the player to be hidden! # E.g. if you set both to 1, then the player will be hidden on the map if they are in absolute darkness. -# Or, if you want players only be visible on the surface you set the sky-threshold to something between 1 and 15 -# and the block-threshold to 16. +# Or, if you want players only be visible on the surface, then set the sky threshold to something between +# 1 and 15 and the block threshold to 16. # Default is 0 (don't hide the player). hide-below-sky-light: 0 hide-below-block-light: 0 -# If this is true, players that are on a different world than the viewed map will not appear on the player-list. +# If this is true, players that are on a different world than the viewed map will not appear on the player list. # Default is false hide-different-world: false -# The interval in seconds at which the markers will be written to the map-storage. -# This is useful if you can't create a live-connection between the server and the webapp -# and the markers can only be updated via the map-storage. -# 0 or lower means that the markers will never be written to the map-storage. +# The interval in seconds at which the markers will be written to the map storage. +# This is useful if you can't create a live connection between the server and the webapp +# and the markers can only be updated via the map storage. +# 0 or lower means that the markers will never be written to the map storage. # Default is 0 #write-markers-interval: 10 -# The interval in seconds at which the players will be written to the map-storage. -# This is useful if you can't create a live-connection between the server and the webapp -# and the players can only be updated via the map-storage. -# 0 or lower means that the players will never be written to the map-storage. +# The interval in seconds at which the players will be written to the map storage. +# This is useful if you can't create a live connection between the server and the webapp +# and the players can only be updated via the map storage. +# 0 or lower means that the players will never be written to the map storage. # Default is 0 #write-players-interval: 3 -# Download the skin from mojang-servers when a player joins your server, so it can be used for the player-markers. +# Download the skin from mojang servers when a player joins your server, so it can be used for the player markers. # Default is true 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. +# 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). # Default is -1 player-render-limit: -1 -# The interval in minutes at which a full map-update will be triggered. -# This is IN ADDITION to the normal map-update process (in case that fails to detect any file-changes). +# The interval in minutes at which a full map update will be triggered. +# This is IN ADDITION to the normal map update process (in case that fails to detect any file changes). # ! This DOESN'T re-render the entire map each time, it only checks if there are some changes that have not been rendered yet! # Default is 1440 (24 hours). full-update-interval: 1440 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 aa589b03f..1de842e1b 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 @@ -4,16 +4,16 @@ ## ## # 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). +# 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). storage-type: file -# The path to the folder on your file-system where BlueMap will save the rendered map. +# The path to the folder on your file system where BlueMap will save the rendered map. # The default is: "bluemap/web/maps" root: "${root}" -# The compression-type that BlueMap will use to compress generated map-data. -# Available compression-types are: +# The compression type that BlueMap will use to compress generated map data. +# Available compression types are: # - gzip # - zstd # - deflate 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 807799b28..3a18a8366 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 @@ -4,8 +4,8 @@ ## ## # 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). +# 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). storage-type: sql # The JDBC-Connection URL that is used to connect to the database. @@ -13,8 +13,8 @@ storage-type: sql # The exact format of the URL is determined by the JDBC-Driver you are using. connection-url: "jdbc:mysql://localhost:3306/bluemap?permitMysqlScheme" -# You can set any additional (JDBC-Driver-specific) properties here. -# Usually that's your db-user and password. +# You can set any additional (JDBC-Driver specific) properties here. +# Usually that's your database user and password. connection-properties: { user: "root", password: "" @@ -26,7 +26,7 @@ connection-properties: { 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, +# 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: @@ -38,8 +38,8 @@ max-connections: -1 # (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. -# Available compression-types are: +# The compression type that BlueMap will use to compress generated map data. +# Available compression types are: # - gzip # - zstd # - deflate diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf index 4bf46e52b..91bac9960 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webapp.conf @@ -26,8 +26,8 @@ use-cookies: true # Default is false (perspective-view) default-to-flat-view: false -# The default map and camera-location where a user will start after opening the webapp. -# This is in form of the URL-anchor: Open your map in a browser and look at the URL, everything after the '#' is the value for this setting. +# The default map and camera location where a user will start after opening the webapp. +# This is in form of the URL anchor: Open your map in a browser and look at the URL, everything after the '#' is the value for this setting. # Default is "no anchor" (The camera will start with the topmost map and at that map's starting point). #start-location: "world:0:16:-32:390:0.1:0.19:0:0:perspective" @@ -36,26 +36,26 @@ default-to-flat-view: false min-zoom-distance: 5 max-zoom-distance: 100000 -# The default value of the resolution (settings-menu). +# The default value of the resolution (settings menu). # Possible values are: 0.5, 1, 2 # Default is 1 resolution-default: 1 -# The min, max and default values of the hires render-distance slider (settings-menu). +# The min, max and default values of the hires render distance slider (settings menu). # The values are in blocks. # Default is max:500 default:100 and min:0 hires-slider-max: 500 hires-slider-default: 100 hires-slider-min: 0 -# The min, max and default values of the lowres render-distance slider (settings-menu). +# The min, max and default values of the lowres render distance slider (settings menu). # The values are in blocks. # Default is max:7000 default:2000 and min:500 lowres-slider-max: 7000 lowres-slider-default: 2000 lowres-slider-min: 500 -# Here you can specify an alternative base URL where all of the map-data is loaded from. +# Here you can specify an alternative base URL where all of the map data is loaded from. # Default is "maps" #map-data-root: "https://cdn.my-domain.com/mapdata" diff --git a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf index 89c283944..44174b457 100644 --- a/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf +++ b/common/src/main/resources/de/bluecolored/bluemap/config/webserver.conf @@ -4,7 +4,7 @@ ## ## # With this setting you can disable the integrated webserver. -# This is useful if you want to only render the map-data for later use, or if you setup your own webserver. +# This is useful if you want to only render the map data for later use, or if you setup your own webserver. # Default is true enabled: true @@ -17,9 +17,9 @@ webroot: "${webroot}" # Default is 8100 port: 8100 -# Config-section for webserver-activity logging: +# Config-section for webserver activity logging: log: { - # The file where all the webserver-activity will be logged to. + # The file where all the webserver activity will be logged to. # Comment out to disable the logging completely. # Java String formatting syntax can be used to add timestamps, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html # Default is no logging. @@ -30,16 +30,16 @@ log: { # Default is false (overwrite the file). append: false - # The format of the webserver-acivity logs. + # The format of the webserver acivity logs. # The syntax is the Java String formatting syntax, see: https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html # Possible Arguments: | Example output # 1 - the source address (ignoring any xff headers). | 10.10.10.10 # 2 - the source address (using the (leftmost) xff header if provided). | 88.66.44.22 - # 3 - the http-method of the request. | GET - # 4 - the full request-address. | /assets/file.png + # 3 - the http method of the request. | GET + # 4 - the full request address. | /assets/file.png # 5 - the protocol version of the request. | HTTP/1.1 - # 6 - the status-code of the response. | 200 - # 7 - the status-message of the response. | OK + # 6 - the status code of the response. | 200 + # 7 - the status message of the response. | OK # Default is "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" | 10.10.10.10 "GET /assets/file.png HTTP/1.1" 200 OK format: "%1$s \"%3$s %4$s %5$s\" %6$s %7$s" }