From e134421a51dba304b888e176cb8e5b44ecd2fc68 Mon Sep 17 00:00:00 2001
From: Lukas Rieger <TBlueF@users.noreply.github.com>
Date: Thu, 9 Jan 2020 00:27:51 +0100
Subject: [PATCH] Updated Configuration (markdown)

---
 Configuration.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/Configuration.md b/Configuration.md
index 4d41eb4..f9d68b4 100644
--- a/Configuration.md
+++ b/Configuration.md
@@ -33,6 +33,53 @@ maps [
 ### Other general configuration fields
 - The `metrics` field defaults to `true` and controls if bluemap is sending some really small metrics reports. The report only contains the used implementation type *(e.g. 'CLI' or 'Sponge')* and the Version. This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool! Please leave it on :)<br>
 *(Since sponge has it's own metrics control, this setting will be ignored if you use bluemap as sponge-plugin)*
+- `renderThreadCount` defines how many render threads (processes) bluemap will create. Set this to 0 to maximize the utilization of your CPU *(bluemap will create as many threads as available CPU-cores)*. If you set it to a negative value, bluemap will take the number of available cores and add the (negative) defined number to it. So with 8 cores and `renderThreadCount: 2` its `8 + (-2) = 6` threads.
 - With the `data` field you can change the folder where bluemap saves some files it needs during run-time or to save other data.<br>
 *(E.g. the downloaded minecraft-client file, other default resources and the state of your render-tasks if they got paused.)*
-- `renderThreadCount` defines how many render threads (processes) bluemap will create. Set this to 0 to maximize the utilization of your CPU *(bluemap will create as many threads as available CPU-cores)*. If you set it to a negative value, bluemap will take the number of available cores and add the (negative) defined number to it. So with 8 cores and `renderThreadCount: 2` its `8 + (-2) = 6` threads.
\ No newline at end of file
+- The `webroot` field defines the folder where the web-files will be generated to.
+- The field `webdata` defines the folder where the generated maps are saved. This defaults to `<webroot>/data`. The web-app expects them to be in this folder, so don't change this if you don't have a real reason to do so.
+
+## Web-server
+The integrated web-server is the easiest way to host your map to the web, so you can view it in your browser. If enabled, it will host *(using `http`)* all files in the folder defined by the field `webroot` on the defined `ip` and `port`.
+
+To make the config more organized, all fields configuring the web-server have to be inside the `webserver` object:
+```yml
+webserver {
+   enabled: true
+}
+```
+- With the `enabled` field you can enable (`true`) and disable (`false`) the integrated web-server.
+- The field `ip` defines the IP-address the web-server will bind to. If you omit this field, bluemap tries to find and use the default ip-address of your system. If you only want to access your app on the machine that is hosting the map, use `localhost`.
+- With `port` you can change the port that the web-server binds to. The default port is `8100`.
+- The `maxConnectionCount` field limits the max number of active connections that the web-server accepts simultaneously.
+
+## Advanced
+Bluemap offers a lot more options to render your maps. Here is a more advanced example of a map-configuration:
+```yml
+maps: [
+   {
+      id: "world"
+      name: "World"
+      world: "world"
+      renderCaves: false
+      ambientOcclusion: 0.25
+      lighting: 0.8
+      minX: -4000
+      maxX: 4000
+      minZ: -4000
+      maxZ: 4000
+      minY: 50
+      maxY: 126
+      renderEdges: true
+      hires {
+         tileSize: 32
+         viewDistance: 4.5
+      }
+      lowres {
+         pointsPerHiresTile: 4
+         pointsPerLowresTile: 50
+         viewDistance: 7
+      }
+   }
+]
+```
\ No newline at end of file