Upstream/dynmap
1
0
Fork 0
mirror of https://github.com/webbukkit/dynmap.git synced 2024-11-24 19:25:15 +01:00
Code Issues Projects Releases Wiki Activity

updated docs to reflect latest configuration file of Dynmap

JurgenKuyper 2022-12-30 19:36:45 +01:00
parent 43d3577249
commit e8272fdf2d
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Configuration.txt.md

@ -334,7 +334,7 @@ block-alias:
***
### image-format
This setting controls what file type and compression Dynmap should use when saving the tiles. Dynmap supports PNG, JPG, and (WEBP)[] files as well as different quality levels of JPG files. The standard profiles are `png, jpg, jpg-q75, jpg-q80, jpg-q85, jpg-q90, jpg-q95, jpg-q100`. PNG files are uncompressed and allow for the highest quality image of the map however take up the most space. JPG allows you to compress the images and save on space as well as network bandwidth with significantly smaller files. This setting can be overridden in worlds.txt on a per-world or per-map basis. **NOTE:** To use WEBP you must use Dynmap build 426 or later and include the webp tools on their system. [For detailed instructions on WEBP see this Reddit post.](https://www.reddit.com/r/Dynmap/comments/ji7h87/support_for_webp_map_image_format_in_31snapshot/)
This setting controls what file type and compression Dynmap should use when saving the tiles. Dynmap supports PNG, JPG, and WEBP files as well as different quality levels of JPG files. The standard profiles are `png, jpg, jpg-q75, jpg-q80, jpg-q85, jpg-q90, jpg-q95, jpg-q100, webp, webp-q75, webp-q80, webp-q85, webp-q90, webp-q95, webp-q100 and webp-l`. PNG files are uncompressed and allow for the highest quality image of the map however take up the most space. JPG allows you to compress the images and save on space as well as network bandwidth with significantly smaller files. This setting can be overridden in worlds.txt on a per-world or per-map basis. **NOTE:** To use WEBP you must use Dynmap build 426 or later and include the webp tools on their system. [For detailed instructions on WEBP see this Reddit post.](https://www.reddit.com/r/Dynmap/comments/ji7h87/support_for_webp_map_image_format_in_31snapshot/)
The default is:
```
image-format: jpg-q90
@ -511,6 +511,12 @@ webpath: web
```
***
### update-webpath-files
This setting controls whether Dynmap updates the web files if they got updated in a new release of dynmap, if using a custom frontend, this setting should be disabled.
The default is:
```
update-webpath-files: true
```
### exportpath
This setting controls where Dynmap stores the exported OBJ zip file from the `/dynmapexp` command. By default this is a relative path to the Dynmap folder, it also supports absolute paths. If this is changed to a folder outside the minecraft server folder you will need to make sure Dynmap has write permissions to save the file.
@ -851,7 +857,7 @@ round-coordinates: true
***
### msg
These settings control pre-canned messages that users may see. They are all fairly self-explanatory.
These settings control pre-set messages that users may see. They are all fairly self-explanatory.
The default is:
```
msg:
@ -866,7 +872,7 @@ msg:
***
### url
These settings are for advanced use-cases only and do not need to be adjusted for the average setup, for information on configuring these please visit the [[External Webserver Advanced]] page.
These settings are for advanced use-cases only and do not need to be adjusted for the average setup, for information on configuring these please visit the [External Webserver With MySQL/SQLite](https://github.com/webbukkit/dynmap/wiki/%5BTutorial%5D-Setting-up-a-standalone-web-server-with-MySQL-SQLite/) page.
The default is:
```
url:
@ -953,8 +959,23 @@ The default is:
***
### publicURL
This setting sets the plublic URL for use with the /dynmap url command, if not set, the command will not return anything, url should be FQDN (e.g. https://map.thisserver.com/).
The default is:
```
#publicURL: http://my.greatserver.com/dynmap
```
***
### noPermissionMsg
Send this message if the player does not have permission to use the command.
The default is:
```
noPermissionMsg: "You don't have permission to use this command!"
```
### verbose
This enabled verbose startup message, this can be useful for debugging maps or worlds not loading or web server startup issues. Support may ask for this to be enabled, otherwise this should stay false for less startup log spam.
This enables verbose startup message, this can be useful for debugging maps or worlds not loading or web server startup issues. Support may ask for this to be enabled, otherwise this should stay false for less startup log spam.
The default is:
```
verbose: false
@ -986,4 +1007,13 @@ The default is:
#migrate-chunks: true
```
***
### hackAttemtBlurb
Log4J defense: string substituted for attempts to use macros in web chat
The default is:
```
hackAttemptBlurb: "(IaM5uchA1337Haxr-Ban Me!)"
```
Congratulations! You made it to the end of the config file!