selfhosted-apps-docker/minecraft

Minecraft server in docker

guide-by-example

Purpose & Overview

A game - open world, building, survival.

• Official site
• itzg github

Minecraft is written in Java.
This setup is using itzg maintend docker image. Specificly Purpur version which is a fork of Paper which is a fork of Spigot. Few plugings are used which allow to host multiple worlds on the same server.
Also docker-rcon-web-admin container is runnig to be able to do basic console tasks from web interface.

This setup is written in september 2022 with 1.19.2 being the latest build.

Files and directory structure

/home/
└── ~/
    └── docker/
        └── minecraft/
            ├── minecraft-data/
            ├── .env
            └── docker-compose.yml

• minecraft-data/ - a directory where minecraft stores its data
• .env - a file containing environment variables for docker compose
• docker-compose.yml - a compose file, telling docker how to build containers

You only need to provide the files.
The directory is created by docker compose on the first run.

docker-compose

docker-compose.yml

services:
  minecraft:
    image: itzg/minecraft-server
    container_name: minecraft
    hostname: minecraft
    restart: unless-stopped
    env_file: .env
    tty: true
    stdin_open: true
    ports:
      - 25565:25565     # minecraft server players connect
      - 25575:25575     # rcon connection
      - 8100:8100       # bluemap
      - 8123:8123       # dynmap
    volumes:
      - ./minecraft-data:/data

  minecraft-rcon:
    image: itzg/rcon
    container_name: minecraft-rcon
    hostname: minecraft-rcon
    restart: unless-stopped
    env_file: .env
    depends_on:
      - minecraft
    ports:
      - 4326:4326
      - 4327:4327

networks:
  default:
    name: $DOCKER_MY_NETWORK
    external: true

.env

# GENERAL
MY_DOMAIN=example.com
DOCKER_MY_NETWORK=caddy_net
TZ=Europe/Bratislava

# ITZG MINECRAFT SPECIFIC
TYPE=PURPUR
EULA=TRUE
ONLINE_MODE=FALSE
SNOOPER_ENABLED=FALSE
SERVER_NAME=Blablabla
ALLOW_CHEATS=TRUE
MAX_MEMORY=3G
MAX_PLAYERS=50
ENABLE_COMMAND_BLOCK=TRUE
ALLOW_NETHER=TRUE

# ITZG RCON WEB ADMIN SPECIFIC
RWA_ENV=TRUE
RWA_USERNAME=admin
RWA_PASSWORD=admin
RWA_ADMIN=TRUE
RWA_RCON_HOST=minecraft
RWA_RCON_PASSWORD=minecraft
RWA_WEBSOCKET_URL: "ws://rcon.example.com/ws"
RWA_WEBSOCKET_URL_SSL: "wss://rcon.example.com/ws"

Port forwarding

You must forward port 25565 on your firewall to your docker host if you want it world accessible.

Reverse proxy

Caddy v2 is used, details here.

The minecraft server itself does not need this, but plugins do.

First one is bluemap/dynmap, to see real time map of the world.
Second one is for rcon web admin, to be able to quickly manage server from anywhere.

Caddyfile

map.{$MY_DOMAIN} {
    reverse_proxy minecraft:8123
}

rcon.{$MY_DOMAIN} {
  reverse_proxy /ws minecraft-rcon:4327
  reverse_proxy minecraft-rcon:4326
}

Domain

Setup a DNS A-record for you subdomain - minecraft.example.com Will work fine if using default port 25565
If you would want to use a different port, but also would prefer your users to not need to enter minecraft.example.com:30108 then google "minecraft srv record" and you should find correct settings.
Like this one.

Plugins

• multiverse core
• multiverse portals
• multiverse inventory
• multiverse netherportals
• EssentialsX (switch to stable tab)
• EssentialsX Spawn

Why the plugins?
You want one server but you want people to be able to play creative or surival?
Well you need multiverse core.
How do the people move between these worlds?
Well you need multiverse portals.
Should they be able to bring stuff from one world to another? No?
Well you need multiverse inventory.
Should the connecting of worlds with their nether be easy?
Well you need multiverse netherportals.
Should they spawn in lobby on start, but also remember the position in the worlds when entering portals?
Well you need the rest of that shit, EssentialsX and EssentialsX Spawn.

Plugins installation - place the downloaded jar files in to ~/docker/minecraft/minecraft-data/plugins
restart the server

The setup

check if the plugins are loaded using command plugins

creation of the worlds

• check the worlds present - mv list
  these 3 existing worlds [world, nether, end] are grouped and interconnected and will be used as the survival world
• create a new world called "creative_world" - mv create creative_world normal
• teleport to it - mv tp creative_world
• switch mode to creative - mvm set mode creative creative_world
• create a new world called "lobby" - mv create lobby normal -t flat
• teleport to lobby world - mv tp lobby
• remove monsters - mvm set difficulty peaceful
• remove animals - mv modify set animals false
• set adventure - mvm set mode adventure
• build 2 portals, for survival and creative worlds
• get worldedit axe using command - mvp wand
• use left click and right click to select portal area
  after selecting it create a portal named portal1 with destination creative_world - mvp create portal1 creative_world
• same thing with the axe for survival, with destination to "world" - mvp create portal2 world
• you can check your portals configuration on server in > plugins > multiverse-portals > config.yml
• if non OP players cant use portals execute - mvp conf enforceportalaccess false or mv conf enforceaccess false

bonus info
if you have seed mv create snow_world normal -s -5343926151482505487

spawning in the worlds

• pick a spawn point in the lobby and set it with multiple commands
• setspawn
• setworldspawn
• mv setspawn
• edit the file in > plugins > Essentials > config.yml
setspawn-on-join: true
• you would think we are done with spawns, but nope, fuck you, this all lets the game start in spawn location in the lobby world, but when entering creative world you would be starting from its spawn, instead of last position on exit. So... heres how to fix that.
• this command for the inventory plugin makes the world remember last location mvinv toggle last_location
  but with just that change the lobby world position is also remembered and users end up spawning inside of portals instead of specific spawn
• to fix that we set in > plugins > multiverse-inventories > config.yml optionals_for_ungrouped_worlds: false
  
• but our lobby world is ungrouped, so we need to add it to a group using command mvinv group and then following the instructions. Writing the answers in to the console without slash, when it asks about shares, giving last_location and ending with @
  This could be helpful too, but it feels like doing unnecessary steps
• now you should have spawn point in lobby that is always the same, while after entering portals you end up at your last location

Extra Plugins

• AntiPopup - if you dont want that stupid chat popup so thats AntiPopup.
  
• Action Bar Health
  • see mobs health when you fight them, in config I set show on look to false
    I prefered the look of holomobhealth, but its dependancy ProtocolLib is only in beta at the moment, and might be causing issues on my server, did not investigate thoroughly
• Bluemap - map of the world in web gui, real time.Default port 8100

---

Something of this is causing server to ocasionally go to super high disk use and needs restart. Not just container, but entire VM. Will maybe investigate.

• Dynmap - map of the world in web gui, real time. Default port 8123
• Chunky - pre-generates chunks useful for dynmap to fill black patches
• OpeNLogin
• luckperms - manage permissions of players, planned to use, not in use yet. Here is a good video on it.

Comamnds & settings

• /gamerule playersSleepingPercentage 1 - use bed whenever, sleep not dependant on other players

Update

Manual image update:

• docker-compose pull
  
• docker-compose up -d
  
• docker image prune

Backup and restore

Backup

Using borg that makes daily snapshot of the entire directory.

Restore

• down the minecraft container docker-compose down
  
• delete the entire minecraft directory
  
• from the backup copy back the minecraft directory
  
• start the containers docker-compose up -d