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-11 12:03:50 +01:00
parent 3c2cf1585d
commit 8af5ae0c54
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Configuration.md

@ -2,8 +2,10 @@
The main configuration file of bluemap *(`bluemap.conf`)* is formatted using [HOCON](https://github.com/lightbend/config/blob/master/HOCON.md). Please make sure you have a basic understanding of how to use HOCON and what "field", "key" and "value" mean in this context.
If you have no configuration file, bluemap generates an example config file for you.
In this generated config every field has a comment above it with what it does and it's default value *(if it has one)*.<br>
It also has 3 maps pre-configured as an example. Using the list `maps` you can define as many maps as you want. Each configured map will appear in a drop-down the web-app where you can switch between them. **Remember to remove the pre-generated maps if you don't use them!**
In this generated config every field has a comment above it with what it does and it's default value *(if it has one)*.
Using the list `maps` you can define as many maps as you want. Each configured map will appear in a drop-down the web-app where you can switch between them.<br>
The generated config has 3 maps pre-configured as an example. **Remember to remove the pre-generated maps if you don't use them!**
The most basic config simply renders a world in the "world" folder in your current [cwd](https://en.wikipedia.org/wiki/Working_directory) and looks like this:
```yml