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 set up a map plugin on your server. It's a simple process, so let's get started! The map plugins we will be covering are:

Dynmap
Bluemap
Squaremap

Dynmap

Dynmap runs a web server to display its map on a website. To do this, you will need an additional port since your Dynmap web server can't run on the same port. Go to your panel --> ports --> create a new allocation. Note down this port.

Installing the Plugin

Now, let's install the Dynmap plugin. Get it here and upload it to your plugins folder. Once you've done that, restart the server to generate the configuration files for it. Go into the configuration.txt file and set the web server port to the desired port.

Dynmap Configuration

After that, save and restart the server, and Dynmap is successfully set up! To access the map, simply enter your IP and the port assigned to Dynmap in the configuration. We will use 45.134.8.12:8832 as it corresponds to our server.

To load all the chunks of a world onto Dynmap, use the command dynmap fullrender <world name>. For example, dynmap fullrender world. Note that it may take some time to process, and it can be quite resource-intensive, potentially slowing down the server during rendering.

Further configuration options for Dynmap can be found in its configuration.txt file, including support for plugins and other important settings.

Bluemap

Bluemap also runs a web server to display its map on a website. Like Dynmap, you'll need an additional port for this. Go to your panel --> ports --> create a new allocation. Note down this port.

Installing the Plugin

Download Bluemap from here and upload it to your plugins folder. Once done, restart the server to generate the configuration files. Let's review the 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 parameters for map rendering in this file. Once satisfied, save it.

webserver.conf

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

Specify the server's IP address and the port for the web server to run on. If needed, create a new port allocation in the network section for the web server!

plugin.conf

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

To access the map, enter your IP and the assigned port in the browser. We'll use 45.134.8.12:8832, matching our server.

You can further configure the web server's behavior using this config. Modify it as needed for the best web server experience.

That's it! Bluemap setup is straightforward, and for further assistance, you can join their discord server.

Squaremap

Squaremap, like Dynmap and Bluemap, runs a web server to display its map on a website. You'll need an additional port for this as well. Go to your panel --> ports --> create a new allocation. Note down this port.

Installing the Plugin

Download Squaremap from here and upload it to your plugins folder. Once done, restart the server to generate the configuration files. Ensure you download the correct version for your server software.

Configuring the Plugin

In the config.yml, locate this section:

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

In bind, specify the server's IP address, and in port, specify the web server's port. If needed, create a new port allocation in the network section for the web server!

To access the map, enter your IP and the assigned port in the browser. We'll use 45.134.8.12:8832, matching our server.

You can further customize the web server's behavior using this config. Adjust as needed for the best experience.

Updated on: 02/06/2024

Was this article helpful?

Thank you!