Before you begin, make sure you have the following prerequisites installed:
- Docker: Install Docker
- 1.21.4 (214)
- 1.21.3 (82)
- 1.21.1 (132)
- 1.21 (130)
- 1.20.6 (151)
- 1.20.5 (22)
- 1.20.4 (499)
- 1.20.2 (318)
- 1.20.1 (196)
- 1.20 (17)
- 1.19.4 (550)
- 1.19.3 (448)
- 1.19.2 (307)
- 1.19.1 (111)
- 1.19 (81)
| Environment Variable | Description | Default Value | Required |
|---|---|---|---|
MINECRAFT_VERSION |
Minecraft version to use | 1.21.4 | No |
ACCEPT_EULA |
Accept Minecraft EULA (set to "true" if you accept them) | false | Yes |
MEMORY |
Memory allocation for the server | 2G | No |
OP_USERNAME |
Username for the first server operator | - | No |
OP_UUID |
UUID of the first server operator | - | No |
- Pull the Docker image from Docker Hub:
docker pull yefox/minecraft-paper-server- Start the Minecraft Paper server Docker container:
docker run -d -p 25565:25565 -p 8123:8123 --name minecraft-paper-server yefox/minecraft-paper-serverYou can customize the memory allocated to the server by adding the MEMORY environment variable. In the example 4G stands for four Gibibytese.
docker run -d -p 25565:25565 -p 8123:8123 --name minecraft-paper-server -e MEMORY=4G yefox/minecraft-paper-serveYou can also change the Minecraft version of the server easily by adding the MINECRAFT_VERSION environment variable:
docker run -d -p 25565:25565 -p 8123:8123 --name minecraft-paper-server -e MEMORY=4G -e MINECRAFT_VERSION=1.19.1 yefox/minecraft-paper-serveTo set the server's first operator you need to supply two different environment variables. Supply OP_USERNAME with the username, and OP_UUID with the user's associated UUID (check here). The end result should look something like:
docker run -d -p 25565:25565 -p 8123:8123 --name minecraft-paper-server -e MEMORY=4G -e MINECRAFT_VERSION=1.19.1 -e OP_USERNAME=Username -e OP_UUID=11112222-3333-4444-5555-666677778888 yefox/minecraft-paper-serve- Access the Minecraft server in your Minecraft client using the server IP or domain name and port 25565.
- Access Dynmap in your web browser at http://localhost:8123.
To stop and remove the Minecraft Paper server container, use the following commands:
docker stop minecraft-paper-server
docker rm minecraft-paper-server- To modify server settings, edit the server.properties file in the data directory.
- To add or manage plugins, place them in the plugins directory.
- To customize Dynmap settings, edit the dynmap_config.txt file in the
minecraft/plugins/Dynmapdirectory.
From past experiences I noticed that a lot of players do not like interaction with Phantoms. So there are disabled in this template by default. You may still choose you re-enable the feature by using the following command: /gamerule doInsomnia true. To disable them from spawing use /gamerule doInsomnia false which is set and done by default.
There are already some changes made to this template, including the dynmap configuration. Below you will find a small but comprehensive guide about, some basic changes, where some are already done. You may want to use these instructions in some other way.
Most of us server-administrator knowns that process optimisation is one of the lead tasks. Dynmap is maybe one of the hardest plugins to optimise. One of the biggest reasons is physical data-size.
💡 A fully rendered Dynmap with a radius of 15.000 blocks can take up to 100GB in size (With the default config).
There are three default views per world. Note: the 3D-views are in high-resolution:
- Standard top-down view.
- 3D-view on a 30-degree angle faced from the south-east.
- 3D-view of caves (underground).
We are assuming that all of these commands are performed in-game by a player with the right privileges. These commands can be ran in the console. When you are doing this, you need to remove the / before each command.
Before you start editing the Dynmap configuration, you'll need to stop the Dynmap engine. Otherwise the plugin doesn't allow you to edit the config.
// First of all stop the dynmap engine
/dynmap pause allIf there are any worlds named with whitespace in its name, use quotation in the naming; using Dynmap commands.
// Example command, world name with and without quotes
/dmap worldset "Biome Bundle_nether" enabled:false
/dmap worldset world_nether enabled:falseNote that the whole name needs to be in quotes.
Dynmap sees every dimension as a separate world. This is why we need to disable the nether and the end separately.
// Disable specific worlds
// If you want to do an opposite operation, like enabling a certain world. Change false to true.
/dmap worldset world_the_end enabled:false
/dmap worldset world_nether enabled:falseWe want to disable the views that are default per world that aren't disabled before this step. Since we already disabled all worlds expect the New_World and Biome Bundle those are the only ones left. Note: this step will delete all the remaining default views. If you wish to keep one you can!
/dmap mapdelete world:surface
/dmap mapdelete world:flat
/dmap mapdelete world:caveNow that all the default views of the remaining worlds are deleted we want to create some new views. These views are 3D and have the same view-angle as the default, but in a lower resolution, which of-course takes less hard-disk-space.
A list of predefined perspectives can be found here: https://github.com/webbukkit/dynmap/wiki/Full-list-of-predefined-perspectives
// The confention for adding a new world is as followed
// Example
// /dmap mapadd [WorldName]:[WorldViewName] title:[visible name] perspective:[perspective] lighting:[lighting-mode] shader:stdtexture icon:[icon-location]
/dmap mapadd world:South_East title:"South East" perspective:iso_SE_30_lowres lighting:shadows shader:stdtexture icon:images/block_world_surface.png
/dmap mapadd world:North_West title:"North West" perspective:iso_NW_30_lowres lighting:shadows shader:stdtexture icon:images/block_world_surface.pngNow re-enable the dynmap service with:
/dynmap pause none