Dynmap Plugin

Links

Introduction

This plugin is installed on all UniversalCraft Paper servers.

The Dynmap plugin provides a visible map of all worlds that can be viewed in a web browser. The map displays all generated chunks within a world and shows where currently logged in players are located.

Dynmap is also aware of the WorldBorder plugin and will display the configured border on all world maps.

Disk Space Usage

Dynmap is a truly amazing piece of work. It’s usefulness, popularity and extensibility are self-evident given the number of other independent plugins that can interact with it to add their own informational layers onto the world maps. Running Dynmap on your own Minecraft server would certainly be a well received gameplay upgrade for your players. There’s only one problem with adding Dynmap to a Minecraft server. Your disk space requirements will go through the roof!

Dynmap allows you some control over the amount of storage space that the maps it generates will need by way of the “deftemplatesuffix” property as defined in the configuration.txt file within the plugins/dynmap directory. This property makes little difference to the default two-dimensional “flat” maps that this plugin displays, but is much more apparent on the isometric “surface” maps:

Dynmap Isometric Surface Map (“deftemplatesuffix: lowres” Setting)
Dynmap Isometric Surface Map (“deftemplatesuffix: hires” Setting)

At UniversalCraft, we always want to provide the very best experience for our players, so all of our servers are configured to generate “hires” maps. We have experimented with different WorldBorder radii for our worlds and have measured the following maximum disk space requirements as the border of a world increases:

OverWorld Border RadiusDisk Space (hires)
500 blocks783MB
1,000 blocks1,056MB
2,000 blocks3,723MB
5,000 blocks20,035MB
10,000 blocks73,372MB
20,000 blocks284,716MB
Dynmap Disk Space Requirements For Fully Generated High Resolution Maps

So, by the time that you’ve expanded your world border even to just a fairly modest 20,000 block radius, Dynmap is already going to need more than a quarter of a terabyte just for storing the pre-rendered “hires” map tiles!

Commands

/dynmap cancelrender <WorldName>

Cancels all rendering on the specified world.

/dynmap fullrender

Attempts to render all maps of the entire world from your location (or from the center of that world, if issued from the server console).

/dynmap fullrender <WorldName>

Attempts to render all maps of the world named world from the center of that world.

/dynmap fullrender <WorldName>:<SurfaceName>

Attempts to render the map named surface for the world named world from the center of that world.

/dynmap pause all

Pauses, but does not completely cancel, all current map rendering operations. Useful if your players are experiencing lag issues during a rebuilding of the maps.

/dynmap pause none

Resume all map rendering.

/dynmap purgemap <WorldName> <MapName>

Delete all the pre-rendered map files for the specified map and world.

/dynmap purgequeue

Clears the tile update queue, preventing any outstanding areas of the map from being updated.

/dynmap purgeworld <WorldName>

Deletes all previously rendered map files for the specified world.

/dynmap radiusrender <Radius>

Attempts to render at least a radius block area, centered on your current location where you issued the command.

/dynmap radiusrender <Radius> <MapName>

Attempts to render at least a radius block area, centered on your current location of the specified map.

/dynmap radiusrender <WorldName> <X> <Z> <Radius>

Use this command to render a specific area of a map, centered on the X,Z coordinates specified.

/dynmap render

Re-render the one tile of the map where you are standing.

/dynmap updaterender

Attempts to render tiles that need updating, starting at current location, for all maps. Stops at edge of map or at tiles that don’t need updating.

/dynmap updaterender <MapName>

Re-render tiles that need updating, starting at current location, for the specified map. Stops at edge of map or at tiles that don’t need updating.

/dynmap updaterender <WorldName> <X> <Z>

Re-render tiles that need updating for all maps starting at given location on the specified world. Stops at the edge of the map or at tiles that don’t need updating.

/dynmap updaterender <WorldName> <X> <Z> <MapName>

Re-renders tiles that need updating, starting at specified world, map and location.

Configuration

Dynmap-Essentials: config.yml

Disable Showing Player Home Locations:

layer:
  homes:
    enable: false