dockerized-mcpaper-server

by LeoMainini

323 downloads
Not rated
GitHub

Description

# Containerized Minecraft server πŸ‹πŸ§± This project automates creating a Minecraft server using a simple, reproducible, and transportable Docker container. The configuration was built around the requirements for the PaperMC server software. Another runnable type can be used, but…

About

# Containerized Minecraft server πŸ‹πŸ§± This project automates creating a Minecraft server using a simple, reproducible, and transportable Docker container. The configuration was built around the requirements for the PaperMC server software. Another runnable type can be used, but YMMV. ## Requirements ### Docker Engine *…

Details

Author
LeoMainini
Downloads
323
Categories
Other

- Full PaperMC server inside a Docker container
- Only three required inputs: port, JAR URL, RAM
- Persistent data stored in ./volumes/server
- Easy console attach and detach via Docker
- Supports custom volume mounts for extra persistence
- Simple rebuild with docker compose up --build

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name dockerized-mcpaper-server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Set OUT_PORT, SERVER_JAR_URL, and DEDICATED_RAM in docker-compose.yml, then run docker compose up -d from the base folder. Attach to the server console with docker attach <container_name>, detach with CTRL+P+Q, and stop with docker compose down.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "dockerized-mcpaper-server": {
            "dockerized-mcpaper-server": {
                "command": "docker",
                "args": [
                    "compose",
                    "up",
                    "--build"
                ]
            }
        }
    }
}

McpServers

{
    "dockerized-mcpaper-server": {
        "command": "docker",
        "args": [
            "compose",
            "up",
            "--build"
        ]
    }
}

Containerized Minecraft server πŸ‹πŸ§±

This project automates creating a Minecraft server using a simple, reproducible, and transportable Docker container.

The configuration was built around the requirements for the PaperMC server software. Another runnable type can be used, but YMMV.

Requirements

Docker Engine

Install guide

PaperMC server download URL

Copy from the download button here

How-to

The docker-compose.yml leaves some configuration to the end user. The only required inputs are:

OUT_PORT
SERVER_JAR_URL
DEDICATED_RAM

All other inputs are optional and are only present as a simple way to edit values without diving into the server.properties file.

1. Set the URL, output port, and dedicated RAM in docker-compose.yaml
2. Start the server with docker compose up -d from the base folder

To attach to the server console, run docker attach <container_name>
* To detach, press CTRL+P+Q inside the terminal window
3. Stop the server with docker compose down

Nice to knows

Persist more folders from container

The persistent data for the server will be mounted in ./volumes/server. Any data inside the server runnable folder will be persisted.

If other folders need to be persisted, add another entry to the volumes section in docker-compose.yaml, like so:

- type: bind
  source: <HOST PATH>
  target: <PATH IN CONTAINER>

Example for world backups:

- type: bind
  source: /volume/backups
  target: /world_backups

Rebuild image with changes to Dockerfile

If there are changes in the Dockerfile, dependencies, Java version, etc., the image needs to be rebuilt for them to take effect:

docker compose up --build

Any data being persisted will not be deleted when rebuilding the image, for this you must manually delete the persisted folders.

No reviews yet β€” be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.