Skip to content

Minimaps

BananaPuncher714 edited this page Jul 15, 2020 · 1 revision

Minimaps are the core of Cartographer. A server can have an unlimited number of minimaps, but generally don't need more than a few. Each minimap has their own config, and may contain their own overlay, background and disabled images.

The config

name - The name of the minimap. Currently unused, but may be displayed to players.
auto-update - If disabled, the minimap will only render chunks once. Useful if you have an unchanging map.
render-out-of-border - If enabled, then the minimap will render chunks outside of the vanilla world border, and the border defined by WorldBorder.
dither-overlay - If enabled, the overlay will be dithered. May decrease visual quality.
dither-background - If enabled, the background will be dithered. May decrease visual quality.
dither-blacklisted - If enabled, the disabled map image will be dithered. May decrease visual quality.
palettes - A list of palettes to use. The last palette in the list has the most priority. Ex. If the first palette and last palette have different colors for grass blocks, the last one's color will be used. default is always available.
world-whitelist - If enabled, the world blacklist will be treated as a whitelist.
world-blacklist - A list of the names of blacklisted/whitelisted worlds.
default-zoom - The default zoom that players first view the map in. A value of 1 means each pixel has a 1:1 block ratio. 2 = 2 blocks per 1 pixel. .5 = 2 blocks per 1 pixel.
circular-zoom - If enabled, after zooming to the highest zoom, the player access the lowest zoom by zooming in once more, and vice versa.
allowed-zooms - A list of allowed zoom scales, and the order that the zooming occurs in. Can be any scale, but powers of 2 work the best. Values larger than 16 may function oddly.

Images

Each minimap may have their own overlay, background, and disabled images. They belong in the same folder as the config.yml. If an image does not exist, then the map will use the global image instead.

Command management

Minimaps can be created, deleted, loaded and unloaded through commands. View the commands page for more information.