Zenn
🦍

Minecraft Plugin Server を Docker で構築する（Paper）

2024/06/10に公開
Docker
Linux
Game
Minecraft
Ubuntu Server
tech

コンテナ型仮想環境で、Java版マインクラフトのプラグインサーバー『Paper』を構築します。使用するコンテナイメージは Docker 社が運営する公開レジストリの Docker Hub から取得します。

🛠️ 事前準備

デバイスやソフトウェアは以下を用いる。

  • 💻 サーバ機（Ubuntu Server、Docker）
  • 🌐 Docker Hub

1. Docker のインストール

以下の記事より Docker のインストールを済ませておく。
https://zenn.dev/mesgory/articles/e4a707b0c31c76

2. Proxy Server の構築（Velocity）

プロキシを介して接続する場合は中継サーバーを構築しておく。
https://zenn.dev/mesgory/articles/4f22286eda3b8c

3. データ格納用ディレクトリの用意

データを永続的に管理するためのディレクトリを用意する。

🖥️ terminal
# データ格納用ディレクトリの作成（存在しない場合）
mkdir -v /media/shared/minecraft

# カレント・ディレクトリの変更
cd /media/shared/minecraft

🎭 作業手順

1. Docker リポジトリのセットアップ

Compose ファイル を編集する。（詳細は公式ドキュメントを参照）

🖥️ terminal
# Compose ファイルの作成
vi ./compose.yaml
📄 compose.yaml
services:

  # =================================================== #
  #  Paper Server                                       #
  # =================================================== #
  paper:
    container_name: mc_paper
    image: itzg/minecraft-server
    tty: true
    stdin_open: true
    environment:
      ENABLE_ROLLING_LOGS: "TRUE"
      JVM_OPTS: "-XX:MaxRAMPercentage=75"
      TYPE: "PAPER"
      EULA: "TRUE"
      #VERSION: "LATEST"
      MOTD: "The World of Paper Server with Crossplay"
      MAX_PLAYERS: 5
      ENABLE_COMMAND_BLOCK: "TRUE"
      SNOOPER_ENABLED: "FALSE"
      VIEW_DISTANCE: 12
      PVP: "FALSE"
      LEVEL: "lv30066" # a default is "world"
      #ONLINE_MODE: "TRUE"
      ALLOW_FLIGHT: "TRUE"
      USE_NATIVE_TRANSPORT: "TRUE"
      STOP_SERVER_ANNOUNCE_DELAY: 60
      GUI: "FALSE"
      PLUGINS: |
      SERVER_PORT: "30066"
    depends_on:
      - velocity
    ports:
      - "30066:30066/tcp"
      - "30066:30066/udp"
    volumes:
      - ./paper:/data
      - /etc/timezone:/etc/timezone:ro
    restart: unless-stopped

2. Proxy の通信設定

プロキシを介して接続する場合は中継サーバーの設定も編集しておく。

💤 コンテナの初回起動と停止

Compose を使ってアプリケーションを起動し、必要なファイル群が生成されたら一旦停止する。

🖥️ terminal
# コンテナの構築と起動（バックグラウンド実行）
docker compose up -d

#　コンテナの停止
docker compose down

⚙️ Config (compose.yaml)

クロスプレイ環境を実現するために必要な設定へと書き換える。

🖥️ terminal
# Compose ファイルの編集
vi ./compose.yaml
📄 compose.yaml
services:
  # ＊＊＊ 設定変更箇所のみ抜粋 ＊＊＊
  paper:
    environment:
      ONLINE_MODE: "FALSE"
      PLUGINS: |
        https://download.geysermc.org/v2/projects/floodgate/versions/latest/builds/latest/downloads/spigot

⚙️ Config (paper-global.yml)

🖥️ terminal
# プロキシ（Velocity）を利用する
# proxies.velocity.enabled : true
sed -i -e "s/    enabled: false$/    enabled: true/g" ./paper/config/paper-global.yml

# 秘密鍵を設定する
# proxies.velocity.secret : 'IPパケット転送用の秘密鍵の値'
SECRET=`cat ./velocity/forwarding.secret`
sed -i "s/secret: ''/secret : '$SECRET'/" ./paper/config/paper-global.yml

🔌 Floodgate

🖥️ terminal
# キーファイルの配置
mv ./paper/plugins/floodgate/key.pem ./paper/plugins/floodgate/key.pem.org
cp ./velocity/plugins/floodgate/key.pem ./paper/plugins/floodgate/

3. Server の環境設定（リスト作成）

各サービスの設定をサーバー環境に合わせて編集する。

👥 OPリスト

任意のプレイヤーに管理者権限を付与する。

🖥️ terminal
# ops.txt を作成（オペレータ権限を付与するユーザーを列挙する）
tee -a ./paper/ops.txt <<EOF >/dev/null
username
EOF

4. Docker コンテナの起動

Compose を使ってアプリケーションを起動する。

🖥️ terminal
# コンテナの構築と起動（バックグラウンド実行）
docker compose up -d

⛳️ 動作確認

1. Minecraft Server の動作確認

リンク先の記事 ⛳️ 動作確認 を参考にして、サーバーに接続できることを確認する。

サーバー名 サーバーアドレス（host:port）
任意の名前 ホスト名またはIPアドレス:30066
※プロキシを介して接続する場合は中継サーバーのポートを指定する

https://zenn.dev/mesgory/articles/e3dc962bd38dfd

Discussion