Upstream/BlueMap
1
0
Fork 0
mirror of https://github.com/BlueMap-Minecraft/BlueMap.git synced 2024-11-22 02:26:00 +01:00
Code Issues Projects Releases Wiki Activity

Updated Configuration (markdown)

Lukas Rieger 2020-01-09 03:56:15 +01:00
parent 15db6d2030
commit dc5efa80c6
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Configuration.md

@ -22,8 +22,8 @@ maps [
- The `accept-download` field defaults to `false` but you **need to set this to** `true` if you want to use bluemap! Before doing that, please read the following carefully:
> By changing the setting `accept-download` to `true` you are indicating that you have accepted mojang's [EULA](https://account.mojang.com/documents/minecraft_eula),<br>
> you confirm that you own a license to Minecraft (Java Edition)<br>
> and you agree that BlueMap will download and use a minecraft-client-jar from mojang's servers *(https://launcher.mojang.com/)*<br>
> 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.<br>
> and you agree that BlueMap will download and use a minecraft-client-jar from mojang's servers *(https://launcher.mojang.com/...)*<br>
> The downloaded 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.<br>
> 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.)*
- The `maps` field is a list (`[]`) of one or more objects (`{}`). Every object represents one map that bluemap will render. You can render multiple maps of multiple worlds, or even multiple maps of the same world if you want. Each map-object should have the following fields:
- The `id` field to define the id of the map, this id can only contain normal letters (a-z) numbers and underscores and has to be unique. It is used for example as folder-name where the rendered map-models will be saved.
@ -33,7 +33,7 @@ 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.
- `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.)*
- The `webroot` field defines the folder where the web-files will be generated to.