Articles on: Plugin Setup
This article is also available in:

How to install and use a map plugin ( Dynmap/Bluemap/Squaremap ) [Java]

In this article, you'll learn how to install and setup a map plugin on your server. It's a simple process, so let's get started!
The map plugins we will be covering are
Dynamp
Bluemap
Squaremap

Dynmap



Dynmap runs a webserver to show it's map on a website. For doing this, you will need an additional port, as your dynmap webserver can't run on the same port, so go to your panel --> ports --> create new allocation. Note down this port

Installing the plugin



Now, we will install the Dynmap plugin. Get it here - https://www.spigotmc.org/resources/dynmap.274/ and upload it to your plugins folder. Once you do that, restart the server to generate the configuration files for it. Go into the configuration.txt file, and set the webserver-port to the port that you want



Once done, just save and restart the server, and we've successfully setup Dynmap!



To access the map, just put in your browser your ip and the port that you assigned to dynmap in the configuration!
We will use 45.134.8.12:8832 since it is the IP and port that corresponds to our server

To load all of the chunks of a world onto the Dynmap, use the command dynmap fullrender <world name>.
For example, dynmap fullrender world.

It may take some time to process, and it is quite intensive to run, so the server may slow a bit whilst it renders.

You can further configure how you want Dynmap to be used by editing it's configuration.txt file, adding support for plugins that have it, and for other important settings!

Bluemap



Bluemap runs a webserver to show it's map on a website. For doing this, you will need an additional port, as your dynmap webserver can't run on the same port, so go to your panel --> ports --> create new allocation. Note down this port

Installing the plugin



Download bluemap from here , and upload it to your plugins folder. Once you do that, restart the server to generate the configuration files for it. Let's check render.conf first!

render.conf



webroot: "bluemap/web"
useCookies: true
enableFreeFlight: true
maps: [
  {
    id: "world"
    name: "World"
    world: "world"
    # Optional advanced config fields:
    startPos: [500, -820]
    skyColor: "#7dabff"
    ambientLight: 0
    renderCaves: false
    minX: -4000
    maxX: 4000
    minZ: -4000
    maxZ: 4000
    minY: 50
    maxY: 126
    renderEdges: true
    useCompression: true
    ignoreMissingLightData: false
  },
  {
    # ... more maps
  }
]


You can define the parameters for your map rendering in this file. As you can see, there's a lot of things to modify, so take your time to read through! Once you are satisfied, save it.

webserver.conf



enabled: true
webroot: "bluemap/web"
ip: "123.45.6.78"
port: 8100
maxConnectionCount: 100


In this file, specify the IP address of your server ( You can find that at the console page ), and the port for the webserver to run on. If you don't have a port, you can go to the network section and create a new allocation, and use that for your webserver!

plugin.conf



liveUpdates: true
skinDownload: true
hiddenGameModes: [
  "spectator"
]
hideInvisible: true
hideSneaking: false
fullUpdateInterval: 1440


To access the map, just put in your browser your ip and the port that you assigned to dynmap in the configuration!
We will use 45.134.8.12:8832 since it is the IP and port that corresponds to our server

You can use this config to determine how you want the webserver to behave. The options here are pretty self-explanatory, so, modify it as you please to make your webserver experience the best it can be!

That's about it! Bluemap is super easy to setup, and should you run into any problems, you can always join their discord server for further help

Squaremap



Squaremap runs a webserver to show it's map on a website. For doing this, you will need an additional port, as your dynmap webserver can't run on the same port, so go to your panel --> ports --> create new allocation. Note down this port

Installing the plugin



Download Squaremap from here , and upload it to your plugins folder. Once you do that, restart the server to generate the configuration files for it. Make sure you download the correct version in accordance to your server software

Configuring the plugin



In the config.yml, find this section

internal-webserver:
    enabled: true
    bind: 0.0.0.0
    port: 8080


In bind, specify the IP address of your server ( You can find that at the console page )
In port, specify the port for the webserver to run on. If you don't have a port, you can go to the network section and create a new allocation, and use that for your webserver!

To access the map, just put in your browser your ip and the port that you assigned to dynmap in the configuration!
We will use 45.134.8.12:8832 since it is the IP and port that corresponds to our server

You can use the config further to determine how you want the webserver to behave. The options here are pretty self-explanatory, so, modify it as you please to make your webserver experience the best it can be!

Updated on: 14/06/2022

Was this article helpful?

Share your feedback

Cancel

Thank you!