Table of Contents
These instructions are for the internal web server Dynmap starts up on a Linux based distribution. They are basic in nature and do not go into the customisation you can do to Dynmap.
- Download the latest
Dynmap.jar
file, for your type of server, and place it into the./server/plugins/
or./server/mods/
directory. - Startup or restart your server for Dynmap. DO NOT ever
/reload
your server. This will break Dynmap and a restart will be required to fix it. - Check the server console and make sure Dynmap says
Web server started on address 0.0.0.0:8123
- While logged into Minecraft and on the server, type
/dynmap radiusrender 100
.- This will tell Dynmap to render a small area around where your player currently is in your world so you can actually see something on the map instead of a black screen.
- If the server is hosted locally on the same machine you're on, open a web browser and go to http://localhost:8123/.
- If it's not hosted locally or to allow other people to view the map, they'll need to go to
http://<Server IP>:8123/
.- Make sure it's HTTP and not HTTPS. Some browsers or browser extensions switch to HTTPS automatically and at this moment, Dynmap will not work on HTTPS.
- Replace
<Server IP>
with your server IP.
- If you get a took too long to respond error then the router/firewall of the machine the server is running on is blocking you from connecting. You'll need to Port Forward and/or check the machine's firewall to allow port 8123.
- At this point Dynmap should be working properly. You should have received the "web server started" message, and able to view a small part of the map as well as players. Now you'll want to do
/dynmap fullrender
so the entire map appears.
Note 1: Dynmap does not generate chunks. It only renders images of chunks that exist. If you'd like more of the world visible than you can either download, install, and run a pre-generator plugin/mod or explore your world. If you go with the pre-generator then when it's done you'll want to /dynmap purgeworld
then /dynmap fullrender
.
Note 2: If you're using a custom world, like an earth map, or one made with world painter, you'll need to download, install, and run a pre-generator plugin/mod as those worlds are missing some data that doesn't get added until the chunks are loaded and as a result Dynmap is unable to see those chunks as existing without said data.
External Web Server
If you'd like to use an external web server then these tutorials are available to you:
- Apache2 for Debian/Ubuntu: Dynmap with apache2 on Debian
- Apache/httpd for Arch Linux: Dynmap with Apache httpd on Arch Linux
- Lighttpd for Arch Linux: Dynmap with lighttpd on Arch Linux
- Nginx: Dynmap with Nginx (courtesy of cryptk)
HTTPS-ing / Port Omitting / Custom Domain
If you're running the internal web server instead of an external one and you'd like to HTTPS your connection to Dynmap, omit the port from your link or replace the IP with your own domain that you own then you can setup Nginx as a Reverse Proxy
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