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-10 23:16:03 +01:00
parent 501d8a9acf
commit c1d911a12b
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Configuration.md

@ -54,7 +54,7 @@ webserver {
- 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 with all available fields used:
Bluemap offers a lot more options to render your maps. In the most cases you don't need this, so you can safely omit Here is a more advanced example of a map-configuration with all available fields used:
```yml
maps: [
{
@ -92,4 +92,14 @@ maps: [
- The fields `minX`, `minY`, `minZ`, `maxX`, `maxY` and `maxZ` define the "bounds" of the rendered world. So if you only want to render a specific area of your world you can do this here. With the y-fields you can also render only blocks in certain heights. You can use that to - for example - remove the ceiling of the nether to be able to see the lower areas in the render.
- If you limited the bounds of your map with the fields above, you can use the field `renderEdges` to define how those "edges" of your map will be rendered. This is best explained with an example:
![renderEdgesOnOff.jpg](https://bluecolored.de/paste/renderEdgesOnOff.jpg)
![renderEdgesOnOff.jpg](https://bluecolored.de/paste/renderEdgesOnOff.jpg)
If you want, you can even change the size of the rendered tiles and the resolution of the low-res models. This is **not recommended** though, wrong settings here can severely break bluemap or even crash the server or the web-app.<br>
Here is the explanation for each of them:
- Fields in the `hires` object modify the high-resolution tiles. Those are the tiles you see if you zoom in on the map.
- The `tileSize` field defines the amount of blocks each tile is wide. So with a value of `32`, each map-tile consists of a 32 * 32 chunk of your world.
- `viewDistance` changes the default amount of how many **tiles** in each direction will be loaded at once by the web-app. *(The view distance can also be adjusted in the web-app with a slider)*
- Fields in the `lowres` object modify the low-resolution tiles. Those are the tiles you see if you zoom out on the map to get an overview.
- This is a bit tricky now: The `pointsPerHiresTile` field defines the amount of low-res-points on a low-res-tile that each high-res-tile will occupy. So if the `tileSize` of the high-res tiles is `32` and the `pointsPerHiresTile` is `4`, each low-res-point will contain a `32/4 = 8` -> 8 * 8 chunk of your world. This is why you have to always choose values that result in an integer if you use that calculation!
- The `pointsPerLowresTile` field is the amount of how many low-res-points each low-res-tile is wide.
- And finally the `viewDistance` defines the default amount of low-res-tiles the web-app will load at once in each direction. *(The view distance can also be adjusted in the web-app with a slider)*