Added the configs to the wiki

Author: TechnicJelle

Gemfile

@@ -5,3 +5,5 @@ gem "jekyll", "~> 4.3" # installed by `gem jekyll`
 
 gem "just-the-docs", "0.10.1" # pinned to the current release
 # gem "just-the-docs"        # always download the latest release
+
+gem 'jekyll-relative-links'

Gemfile.lock

@@ -53,6 +53,8 @@ GEM
       webrick (~> 1.7)
     jekyll-include-cache (0.2.1)
       jekyll (>= 3.7, < 5.0)
+    jekyll-relative-links (0.7.0)
+      jekyll (>= 3.3, < 5.0)
     jekyll-sass-converter (3.1.0)
       sass-embedded (~> 1.75)
     jekyll-seo-tag (2.8.0)
@@ -105,6 +107,7 @@ PLATFORMS
 
 DEPENDENCIES
   jekyll (~> 4.3)
+  jekyll-relative-links
   just-the-docs (= 0.10.1)
 
 BUNDLED WITH

_config.yml

@@ -22,4 +22,7 @@ exclude:
 
 sass:
   quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
-  silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607
+  silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607
+
+gems:
+  - jekyll-relative-links

_sass/custom/custom.scss

@@ -119,3 +119,30 @@ th {
     margin-left: calc( (100% - #{$page-width}) / 2 + #{$sidebar-width} );
   }
 }
+
+section.config-indent {
+  --indent-size: 2em;
+
+  &::before, &::after {
+    position: relative;
+    left: calc(-1 * var(--indent-size) - 0.2em);
+  }
+
+  &::before { content: "{"; }
+  &::after  { content: "}"; }
+
+  & :first-child { margin-top:    0; }
+  & :last-child  { margin-bottom: 0; }
+
+  padding-left: var(--indent-size);
+
+  --bracket-height: 2em;
+  border-left: 1px solid transparent;
+  border-image: linear-gradient(to bottom,
+    transparent var(--bracket-height),
+    grey var(--bracket-height),
+    grey calc(100% - var(--bracket-height)),
+    transparent calc(100% - var(--bracket-height))
+  );
+  border-image-slice: 1; 
+}

wiki/configs/Core.md

@@ -0,0 +1,73 @@
+---
+layout: page
+title: Core
+parent: Configs
+grand_parent: Wiki
+nav_order: 1
+---
+
+# Core-Config
+
+> **Info:**  
+> When a "default" is mentioned for any option, it is meant that if the option is commented out, that is what BlueMap will use.  
+> This may not be the same as the option that is pre-filled-in.
+{: .info }
+
+## `accept-download`
+By changing this setting 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 [Mojang's servers](https://piston-meta.mojang.com/mc/game/version_manifest.json) 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.)
+
+## `data`
+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"`
+
+## `render-thread-count`
+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.  
+(So a value of -2 with 6 cores results in 4 render-processes)
+
+_Default varies per machine_
+
+## `scan-for-mod-resources`
+Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world-directories.
+
+_Default is_ `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 [metrics.bluecolored.de/bluemap](https://metrics.bluecolored.de/)
+
+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":"bukkit","version":"5.13","mcVersion":"?"}`
+
+_Default is_ `true`
+
+## `log`
+Config-section for debug-logging
+
+<section markdown="1" class="config-indent">
+
+### `file`
+The file where the debug-log will be written to.  
+Comment out to disable debug-logging completely.
+
+[Java String formatting syntax](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html) can be used to add time.
+
+_Default is no logging_
+
+### `append`
+Whether the logger should append to an existing file, or overwrite it
+
+_Default is_ `false`
+
+</section>

wiki/configs/Maps.md

@@ -0,0 +1,218 @@
+---
+layout: page
+title: Maps
+parent: Configs
+grand_parent: Wiki
+nav_order: 5
+---
+
+# Map-Config
+
+In your `maps` directory, there is one `.conf` file per map.  
+Usually, that will be three: `world.conf`, `world_nether.conf`, and `world_the_end.conf`,
+but may be more or less depending on the amount of loaded worlds when BlueMap was first installed.
+
+You can copy another map config to create a new map.
+You will probably want to change at least the [`world`](#world) and [`name`](#name) options,
+but you don't actually have to! By keeping them the same, you can have multiple maps of the same world.
+
+> **Info:**  
+> When a "default" is mentioned for any option, it is meant that if the option is commented out, that is what BlueMap will use.  
+> This may not be the same as the option that is pre-filled-in.
+{: .info }
+
+## `world`
+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.)
+
+## `dimension`
+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.
+
+## `name`
+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_
+
+## `sorting`
+A lower value makes the map sorted first (in lists and menus), a higher value makes it sorted later.  
+The value needs to be an integer, but it can be negative.
+
+You can change this at any time.
+
+_Default is_ `0`
+
+## `start-pos`
+The position on the world where the map will be centered if you open it.
+
+You can change this at any time.
+
+_This defaults to the world-spawn if you don't set it._
+
+## `sky-color`
+The color of the sky as a hex-color
+
+You can change this at any time.
+
+_Default is_ `"#7dabff"`
+
+## `void-color`
+The color of the void as a hex-color
+
+You can change this at any time.
+
+_Default is_ `"#000000"`
+
+## `sky-light`
+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.
+
+You can change this at any time.
+
+_Default is_ `1`
+
+## `ambient-light`
+Defines the ambient light-strength that every block is receiving, regardless of the sunlight/blocklight.
+
+`0` is no ambient light, `1` is fully lighted.
+
+You can change this at any time.
+
+_Default is_ `0`
+
+## `remove-caves-below-y`
+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`)  
+Set to a very low value to remove nothing and render all caves (e.g. `-10000`)  
+
+_Default is_ `55` _(slightly below water-level)_
+
+## `cave-detection-ocean-floor`
+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-uses-block-light`
+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`](#remove-caves-below-y))
+
+**Changing this value requires a re-render of the map.**
+
+_Default is_ `false`
+
+## `min-inhabited-time`
+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`
+
+## `render-mask`
+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.
+
+You can use `/bluemap fix-edges <map>` to fix any remaining issues.
+
+Please check out [this wiki page](/wiki/customization/Masks.md) for more detailed information on how to configure this.
+
+_Default is no mask; BlueMap will render everything that exists._
+
+## `render-edges`
+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`](#render-mask) above.
+
+**Changing this value requires a re-render of the map.**
+
+_Default is_ `true`
+
+## `edge-light-strength`
+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`
+
+## `enable-perspective-view`
+Whether the perspective view will be enabled for this map.
+
+**Changing this to `true` requires a re-render of the map, only if the hires-layer is enabled and free-flight view is disabled.**
+
+_Default is_ `true`
+
+## `enable-flat-view`
+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.
+
+_Default is_ `true`
+
+## `enable-free-flight-view`
+Whether the free-flight view will be enabled for this map.
+
+**Changing this to `true` requires a re-render of the map, only if the hires-layer is enabled and perspective view is disabled.**
+
+_Default is_ `true`
+
+## `enable-hires`
+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.
+
+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`
+
+## `storage`
+This defines the [storage-config](storages/) that will be used to save this map.
+
+You can find your storage configs next to this config file in the 'storages'-folder.
+
+**Changing this value requires a re-render of the map. The map in the old storage will not be deleted.**
+
+_Default is_ `"file"`
+
+## `ignore-missing-light-data`
+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:
+- For those chunks, every block will always be fully lit
+- Night-mode might not work correctly
+- Caves will always be rendered (ignoring the [`remove-caves-below-y`](#remove-caves-below-y) setting)
+
+_Default is_ `false`
+
+## `marker-sets`
+Here you can define any static marker-sets with markers that should be displayed on the map.
+
+You can change this at any time.
+
+If you need dynamic markers, you can use any plugin that integrates with BlueMap's API.  
+[Here is a list.](/community/3rdPartySupport.md)
+
+Please check out [this wiki page](/wiki/customization/Markers.md) for information on how to configure this.