Config.yml

Config.yml

This page will explain all the options in the config.yml file

# Click on a setting to learn more about it.

settings:
  debug-mode: false
  language-file: lang-en.yml
  web-directory:
    path: web
    read-only: false
    tile-format: png
  internal-webserver:
    enabled: true
    bind: 0.0.0.0
    port: 8080
world-settings:
  default:
    enabled: false

settings

This section holds all the plugin's global settings.

settings.debug-mode

Default value: false

When set to true, extra data will be printed to the console/logs.

Use this when trying to hunt down bugs.

settings.language-file

Default value: lang-en.yml

This selects the language file to use from the locales/ directory.

Any entries in the selected file that do not exist will default to English.

settings.web-directory

Various settings for the web directory.

settings.web-directory.path

Default value: web

This is the directory where all the plugin's website files are located.

This is a relative path, unless it starts with / in which case it will be absolute.

settings.web-directory.read-only

Default value: false

When set to true, the plugin will not try to overwrite the contents of the web directory.

Use this when you make your own edits to the contents of the web directory. But be careful, updating the plugin may require updates to the contents, which will fail if this is set to true.

settings.web-directory.tile-format

Default value: png

This controls the format of the tile images used in the map.

Valid options are: png or webp

settings.internal-webserver

Various settings for the internal web server

settings.internal-webserver.enabled

Default value: true

Whether or not the internal web server should run.

Disable this if you want to use an external server without being a reverse proxy (apache/nginx/etc).

settings.internal-webserver.bind

Default value: 0.0.0.0

This is the IP of the interface you want the internal web server to bind to.

Note: This is NOT always the same as your public facing IP.

Warning: If you don't understand what this is, leave it set to 0.0.0.0

settings.internal-webserver.port

Default value: 8080

This is the port the internal web server listens on.

Note: If you use a panel (like pterodactyl), make sure the port is allocated.

world-settings

This section holds world specific settings.

Settings in the default section will apply to all worlds. This is where the majority of your settings will be set.

Add specific worlds to this section to override things in the default section for that world.

world-settings.default

The default section. Settings here will be applied to all worlds

world-settings.default.enabled

Default value: false

This controls if all worlds are enabled or not by default.

Set this to false if you have many worlds, but only want a few to be enabled using overrides.

Set this to true if you have a few worlds, or want the majority to be enabled and a few disabled using overrides.