Dynmap®
* MAIN SUPPORT IS NOW ON DISCORD *
For further discussion and announcements, see us on Reddit or Twitter.
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.
Components allow you to add/remove functionality to make Dynmap suit your needs. Using the components Dynmap comes supplied with, there is support for chat balloons, web-to-game chat, and configurable markers, areas, and lines.
Features
- Highly configurable maps per world
- Real-time updates: maps are kept in sync with your world in real-time, updates are shown while your leave your browser open
- Players with their faces are visible on the map
- Chat messages are visible (as balloons or in a chatbox) on the map.
- Map viewers can chat to players in-game.
- Current Minecraft time is visible on the map.
- Current Minecraft weather is visible on the map.
- WorldGuard, Residence, Towny and Factions regions that can be visible on the map (through corresponding Dynmap-* plugins)
- Overall highly configurable and customizable.
Installation
Copy dynmap-*.jar into your plugins directory. If you are upgrading, delete the previous dynmap-*.jar - you do NOT need to delete the plugins/dynmap directory or its contents.
If you are running a separate webserver (like Apache) you may need to copy the files from 'plugins/dynmap/web/' to a directory in your http-root and follow this guide. When upgrading, make sure you also upgrade the copied files.
First time use
When you start CraftBukkit, you should be able to navigate to http://yourserverip:8123/ in your browser. In case you are running CraftBukkit on the PC you are currently working on, you can navigate to http://localhost:8123/. You should be able to see the players who are in-game. Note that the map is not yet rendered, therefore the background will be black.
If you are planning on using the HD renderer, now would be a good time to do so. Enable 'deftemplatesuffix: hires' in the top of configuration.txt. More information about deftemplatesuffix is available at Base plugin settings.
If you just want to see Dynmap work, use the following command in-game: /dynmap fullrender. The wiki contains more information about commands and permissions. The map should reveal itself gradually in the browser, give it some time. Progress messages indicate that Dynmap is working and will show when the render is completed.
Configuration
Dynmap Add-Ons:
Both to demonstrate the API, and to help manage the growth of this already-huge plugin, we've started producing additional plugins for Dynmap. All of these will depend on Dynmap and interface through its APIs, but only need to be added by folks that are interested in the additional function they provide:
- dynmap-mobs: Provides marker layer for real-time position of selected mobs on dynmap maps.
- dynmap-residence: Successor to the 'regions' support for Residence in Dynmap, with live update of Residence changes
- Dynmap-WorldGuard: Successor to the 'regions' support for WorldGuard in Dynmap, with live update of WorldGuard changes
- Dynmap-Towny: Successor to the 'regions' support for Towny in Dynmap, with live update of Towny changes
- Dynmap-Factions: Successor to the 'regions' support for Factions in Dynmap, with live update of Factions changes
- Dynmap-CommandBook: Add support for showing /home and /warp locations defined using CommandBook.
- Dynmap-Essentials: Add support for showing /home and /warp locations defined using Essentials.
- Dynmap-GriefPrevention: Add support for showing Grief Protection claims
- Dynmap2CraftIRC3: Integrate Dynmap's web chat with IRC via CraftIRC
- Dynmap-SimpleClans: Integrate SimpleClans with Dynmap
- Dynmap-HeroChat: Integrate HeroChat v5.5+ with Dynmap
- Dynmap-PhysicalShop
- Dynmap-pyLandmarks
- Dynmap-PreciousStones: Integrate PreciousStones with Dynmap
- Dynmap-AdminCmd: Integrate AdminCmd with Dynmap
- Dynmap-PlayerWarp
- Dynmap-Citizens: Integrate Citizens with Dynmap
Mods integrated with Dynmap:
The following mods are known to support dynmap integration without needing an add-on:
Also, for the best response to questions and such, please post comments to our main forum thread - http://www.minecraftforum.net/topic/1543523-dynmap-dynamic-web-based-maps-for-minecraft/. Once again, having more than one place just isn't helpful, and this is where the 'Dynmap Community' already operates.
Disclosure
This plugin utilizes bStats.org plugin metrics system, which means that the following information is collected and sent to bstats.org:
- A unique identifier
- The server's version of Java
- Whether the server is in offline or online mode
- The plugin's version
- The server's version
- The OS version/name and architecture
- The core count for the CPU
- The number of players online
- The Metrics version
Donations and Tips
Dynmap and my other mods and plugins have always been free, as I work on them as time permits and not as a job - the upside is that the price is good, the downside is they get the time I have left after working, taking care of my family, and other things!
I've set up a coffee-fund jar (I believe in the theory that software developers are machines that turn caffeine into code), for anyone who wants to throw in some tips! For Patreon - https://www.patreon.com/dynmap or for Ko-Fi https://ko-fi.com/michaelprimm
This probably going to make everyone on my server explode in joy. How much will this effect the server when it comes to lag?
Was joking around with some friends and one of them thought of an interesting idea. As of current, the map shows where the player is with his face. How about separate icons that show underneath, or attached to the bottom, of the image to show when they are in a minecart or boat. Basically, shows an minecart image under the face as if the face was inside the minecart. Same with the boat.
To add onto the his idea, maybe a miner's hat for when the player is surrounded by dirt/stone (or just under a specified world height) and has a pickaxe and/or shovel in his hot bar.
@vindictator1972
Yes, it only works for the HD renderer of course. See here how to define a custom shader (look for 'TexturePackHDShader'): https://github.com/webbukkit/dynmap/wiki/Defining-custom-shaders Use the name of your custom-defined shader in the 'shader:' entry of your template (I guess that would be 'templates/normal-hires.txt'. More info on this is found here: https://github.com/webbukkit/dynmap/wiki/HD-Map-Configuration
Quick question,
is it possible to use a custom texture pack on the map?
im not sure if you posted it in the wiki or something but thanks.
@DJCharlie
Yes, I currently do this. You do lose the chat though. This wasn't a big deal for me, as I didn't want it anyway. It's also fairly nice, as I have over 30GB worth of dynmap images and growing!
Assuming your webserver is linux, set up samba, use some SSH port forwards, and mount your samba share on your MC server. Store the entire web-directory on your samba share (make sure the share is web-accessible!) and update your config.js and configuration.txt as instructed in the tutorial.
Just a quick question about running this with a separate webserver. What if my webserver is on a completely different server and hosting service? Can dynmap still be used?
@rockxz3
Why not just generate this with Dynmap? http://dl.dropbox.com/u/76985/webglcraft/webglcraft.html ;)
I get these errors spamming my chat using bukkit 1337
I have a brilliant idea for this! What if you added when you zoom in all the way it goes to like a street view of the map with pictures that people take in game?
@GameCharmer
On the right side of the interface, it shows a list of players. You can left-click them, and it will center the map on that player. :(
I am using bpermissions and everyone is able to do use show/hide commands, just want to make sure it's not me doing something wrong.
Also, is there still any interest in adding this? :D
@ducecat
Open configuration.txt and comment out - class: org.dynmap.ClientComponent type: playermarkers showplayerfaces: true showplayerhealth: true
That should knock out player markers. Might as well knock out chat balloons and chat box while you are at it. Those components are directly above player markers in the config.
I love your mod, but is there any way to not allow people to view players, just the landscape?
Updating to 1337??
Any New Features?
@Ramorous
At the end of configuration.txt, you can uncomment the debuggers, it should then print when tiles are saved. While you're at it, you might as well enable verbose: true (also at the end of configuration.txt), that should print what is done when it is loading the configuration.
@FrozenCow2
So I've disabled all the render triggers, generated the map and restarted the server; Still laggy, just as bad. I'm not blaming the plugin, just wondering what it could be. Is there a debug setting to get some logs on this plugin?
@Ramorous
Did that indeed happen after upgrading from CB 1185? You can disable the render-triggers in configuration.txt. That way no renders will be triggered on block-placements and such. See whether that helps.
@FrozenCow2
I actually rent my server from Fagnet, rented a 1GB server. We have at most 5 players on at a time with a maximum of 12.
The map isn't big, at least I don't think it is. From what I've seen it's about 4000x3000 blocks right now. I love this plugin and so does everyone on my server, but the lag is just unbearable and I looked through and wondered if there's sort of an offline version that doesn't poll the server at all unless you run the full render command which I would have done nightly.
@FrozenCow2
Since updating to the latest RB, my server randomly reboots. Sometimes in a half hour, sometimes in two, but it does randomly reboot. The good news it that it has nothing to do with the amazing Dynmap!
To everyone getting lag spikes when Dynmap generates, try using parallelrendercnt. I have that set to 3 on my quad core server and have not had a single shred of lag from Dynmap, and I run HD maps and have 12 worlds running.
On a side note, I have disabled the local webserver and use samba to store the dynmap tiles on an independent webserver on my local network. Saves on disk I/O, storage space, and fragmentation.
@Ramorous
Are you all noticing this since the new RB of CraftBukkit? I haven't heard so many lag complaints for quite some time + we didn't release any new version of Dynmap, so that can't be the problem. I don't have a big server with many players, so I can't test this very well. My machine can hardly run the client and server next to eachother nowadays, but I don't experience lag once the server is running. Can you all say what version of CraftBukkit you are using? Also, does downgrading CraftBukkit to 1185 help?