mirror of
https://github.com/BlueMap-Minecraft/BlueMap.git
synced 2024-11-25 12:05:13 +01:00
Updated Configuration (markdown)
parent
a6f7431c82
commit
98f68f5c9d
@ -1,13 +1,13 @@
|
||||
## General
|
||||
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.
|
||||
If you have no configuration file, bluemap generates an example config file for you when it is starting.
|
||||
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 on 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:
|
||||
The most basic config simply renders a world in the "world" folder in your current [cwd](https://en.wikipedia.org/wiki/Working_directory) and would look like this:
|
||||
```yml
|
||||
# set this to true, please read below what this means
|
||||
accept-download: false
|
||||
@ -52,7 +52,7 @@ webserver {
|
||||
}
|
||||
```
|
||||
- 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`.
|
||||
- The field `ip` defines the IP-address the web-server will bind to. If you omit this field, bluemap binds to all network-interfaces (`0.0.0.0`). 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.
|
||||
|
||||
@ -78,16 +78,6 @@ maps: [
|
||||
minY: 50
|
||||
maxY: 126
|
||||
renderEdges: true
|
||||
|
||||
hires {
|
||||
tileSize: 32
|
||||
viewDistance: 4.5
|
||||
}
|
||||
lowres {
|
||||
pointsPerHiresTile: 4
|
||||
pointsPerLowresTile: 50
|
||||
viewDistance: 7
|
||||
}
|
||||
}
|
||||
]
|
||||
```
|
||||
@ -99,13 +89,19 @@ maps: [
|
||||
|
||||
![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.
|
||||
- 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.
|
||||
|
||||
> **Important:**<br>
|
||||
> If you change `tileSize`, `pointsPerHiresTile` or `pointsPerLowresTile` you need to delete your previous renders! Delete the complete `web/data` folder! Otherwise you **will** get broken models.
|
||||
## Live-Updates
|
||||
This section controls how player-markers are handled.
|
||||
```yml
|
||||
liveUpdates {
|
||||
enabled: true
|
||||
hiddenGameModes: [
|
||||
"spectator"
|
||||
]
|
||||
hideInvisible: true
|
||||
hideSneaking: false
|
||||
}
|
||||
```
|
||||
- If you don't want any live data being used, set `enabled` to `false`. This disables the full live-updates module.
|
||||
- With `hiddenGameModes` you can control what gamemodes are visible on the map. By default everyone is visible, except players in spectator-mode.
|
||||
- When `hideInvisible` is `true`, players that have the invisibility effect will not be displayed on the map.
|
||||
- `hideSneaking` controls if a player that is sneaking should be visible on the map.
|
Loading…
Reference in New Issue
Block a user