Table of Contents
Dynmap is a Google Maps-like map for your Minecraft server that can be viewed in a browser. Easy to set up when making use of Dynmap's integrated webserver which works out-of-the-box, while also available to be integrated into existing websites running on Apache and the like. Dynmap can render your worlds using different renderers, some suitable for performance, some for high detail.
Supported for Minecraft 1.14.4+ on Spigot and Forge, and works with forks like Paper and SpongeForge.
The original project was developed for hMod by k-zed.
Quick Links- Bukkit Plugin - Forge Mod + BlockScan - Latest Builds
Contact
For users
- Setting up without the Internal Web Server
- Setting up the Dynamic Map plugin under Linux
- Setting up the Dynamic Map plugin under Windows
- Setting up Dynmap through hosting services
- Configuration.txt
- Commands
- Permissions
- Web UI Parameters
- Using Markers
- Custom Block Definitions
- Exporting World Data in Wavefront OBJ Format
For developers
The dynmap project consists of multiple components that have been divided to allow for support of multiple server platforms, as well as allowing our 'published API' to be more clearly expressed. The components needed to build 'dynmap' (the Dynmap plugin for Bukkit) are the following (in the order they need to be built):
-
DynmapCoreAPI - this is the platform neutral API for Dynmap: plugin writers can use this to interface with Dynmap on any platform (by casting the Plugin instance for the dynmap plugin to 'org.dynmap.DynmapCoreAPI').
-
DynmapCore - this is the server-neutral core of Dynmap: nearly all the web and rendering logic for Dynmap is here (as much of it as we can put in). The build results here are not runnable - they're input to the 'dynmap' component build and others (e.g. 'DynmapSpout', which is for the Spout server).
-
dynmap-api - this is the Bukkit-specific API library for Dynmap - it defines the org.dynmap.DynmapAPI interface, which includes Bukkit-specific calls. As with the DynmapCoreAPI (which DynmapAPI extends), take the Plugin instance for 'dynmap' and cast it to org.dynmap.DynmapAPI to access the published interfaces.
-
dynmap - this component builds the actual dynmap-for-Bukkit deliverable, and only includes code which cannot be made server-neutral.
Contents
Setup
- Base Plugin Settings
- Web Setup
- Storage Setup
- HD Map Configuration
- World and template settings
- Guides
Advanced Configuration
- Advanced Map Configuration
- Component Configuration
- Configuration of worlds
- Exporting World Data in Wavefront OBJ Format
- External Webserver Advanced
Mod Support
- Support for Minecraft Servers other than CraftBukkit
- Support for MinecraftForge based mods
- Support for Tekkit
- Custom Block Definitions
- Model Definition Files
- Texture Definition Files
- Defining a Block using a Custom Block Renderer
- Defining a Block using a Volumetric Model
- Defining a Cuboid Block
- Defining a Simple Block
- Defining Cuboid Models
- Defining Volumetric Models
- Special texture file types
- Using custom block renderers
- Incompatible mods