Skip to content

Latest commit

 

History

History
187 lines (120 loc) · 8.73 KB

README_ja.md

File metadata and controls

187 lines (120 loc) · 8.73 KB
Raw

Automatic minecraft spigot builder and runner on podman (docker).

docker.io kekyo/spigot_runner

For english

これは、podman (docker)を使って、完全自動でspigotサーバーを立ち上げるためのスクリプトです。

  • spigotとは、minecraft serverの拡張版、いわゆる"MOD"です。
  • spigotだけでは、ほぼ純正のminecraft serverと変わりありません。ここにコミュニティが開発した各種MODを適用することで、様々な拡張機能をサーバーに追加することができます。
  • spigot自体は、純正のminecraft serverを改造して作られています。そのため、spigotのバイナリをそのまま配布することは許可されていないはずです。
  • そのため、spigotは、純正のminecraft serverを自動的に改造する、BuildToolsというもので構成されています。
  • BuildToolsを使えば、純正のminecraft serverから、spigotを生成することができます。しかし、この作業は（複雑ではありませんが）煩雑です。
  • そこで、このリポジトリのスクリプトを使うと、spigotの生成と実行を、Dockerコンテナを使って完全に自動化することができます。
  • このリポジトリでは、コンテナシステムをpodmanと仮定しています。Dockerでももちろん構いませんし、スクリプト上でpodmanを使っているところをdockerに変えるだけで動作するはずですが、動作確認はしていません。

How to use

動作確認はUbuntu 22.04でのみ行っています。

あらかじめ、以下のようにしてpodmanをインストールしておきます:

# gitとpodmanをインストール
$ sudo apt install git podman

podmanをGUIで操作したいのなら、ついでにcockpitも入れると良いでしょう:

# cockpitも含めてインストール
$ sudo apt install git podman cockpit cockpit-podman

spigot (minecraft)のデータディレクトリを作る

次にゲームのワールドデータなどを格納する、データディレクトリを作ります。場所はどこでもかまいませんし、名前もわかるように命名すれば問題ありません:

# データディレクトリを生成
$ mkdir data

# 絶対パスを確認
$ echo `pwd`/data
/storage0/data

これで準備できました。

spigotを実行する（初回）

Dockerコンテナを実行するには、以下の情報が必要です:

  • spigotのバージョン（minecraftのバージョンに対応します。例えば1.18.1のような番号です）
  • spigotのデータディレクトリの位置（上で作りました。絶対パスが必要です）
  • spigotが公開する、接続用のポート番号（デフォルトは25565ですが、変えることが出来ます）

それでは、実行します:

sudo podman run --name minecraft -it -e SPIGOT_VERSION=1.18.1 -e SPIGOT_OPTIONS=-Xms2048M -v /storage0/data:/spigot-data -p 25565:25565 docker.io/kekyo/spigot_runner
  • --nameは、Dockerコンテナに付ける名前です。省略すると、適当な（割と奇妙な）名前が自動的に付与されます。
  • -itをつけると、コンソール操作が行えます。
  • -e SPIGOT_VERSION=<version>は、spigotのバージョンを指定します（この例では1.18.1です）。
  • -v <data directory>:/spigot-dataは、データディレクトリの位置を指定します（この例では、/storage0/dataです）。後半の:/spigot-dataは固定です。この通りに指定してください。
  • -p <port>:25565は、公開するポート番号です（この例では、同じ25565を指定しています）。これも、後半の:25565は固定です。この通りに指定してください。
  • -e SPIGOT_OPTIONS=<options>は、javaのコマンドラインオプションです。-Xms2048Mは、メモリを最低2GB割り当てます。

初回の実行には、以下のポイントがあります:

  • spigotのビルドが行われます。これは結構時間がかかり、速いマシンでも数分のレベルで作業が発生します。 その間、コンソールには理解しがたいログが大量に流れますが、気長に待ってください。
  • ビルドが終わると、spigotが起動します。minecraft serverを動かしたことがある方なら覚えているかもしれませんが、 初回起動は、eula.txtの修正が発生するため、すぐにサーバーは終了します。 eula.txtは、spigot-dataディレクトリのrunの下にできているはずなので、ライセンスに承諾の上、変更してください。

これで、すべての準備は整いました。

spigotを実行する（本番）

ここまで来れば、あとは先ほどと同じようにコンテナを実行するだけです:

sudo podman run --name minecraft -d -e SPIGOT_VERSION=1.18.1 -e SPIGOT_OPTIONS=-Xms2048M -v /storage0/spigot-data:/spigot-data -p 25565:25565 docker.io/kekyo/spigot_runner
  • -itの代わりに-dを指定しています。これはバックグラウンドで動作させ、コンソール操作は行わないという意味です。連続動作させる場合は、このオプションを指定します。

spigotが生成されていれば、2回目以降はspigotのビルドが行われず、直接spigotが起動します。

これはpodman特有の話ですが、spigotのイメージをシステムの起動時に自動的に起動する（つまり、systemdを用いて完全に自動化する）には、以下のようなコマンドを実行します:

cd /etc/systemd/system
podman generate systemd --name --restart-policy on-failure -f minecraft
systemctl daemon-reload

systemctl enable container-minecraft

これと同じことを、podmanではなくDockerで行うには、Dockerコンテナの自動起動についてのトピックを検索して下さい。（おそらく、環境によって方法が異なります）

cockpitを使って実行する

データディレクトリの準備さえ行えば、あとはcockpitから実行することもできます。 デフォルトでは、cockpitはポート番号9090に配置されるので、ブラウザから https://localhost:9090/ のようにしてアクセスします。

TODO:

以下のように、ポート番号・データディレクトリのパス・spigotのバージョンを指定します。

cockpit-podman

ゲームデータのバックアップ

spigotのプログラムに関する部分は、完全にDockerイメージとコンテナの内部に封じてあります。 普段、ゲームデータのバックアップを行いたい場合は、上記で作ったデータディレクトリ配下をすべてバックアップすればOKです。

バックアップする場合は、コンテナを一旦停止させてください。systemdによる自動化を行っている場合は、以下のようにします:

$ sudo systemctl stop container-minecraft

バックアップしたら、コンテナを再起動します:

$ sudo systemctl start container-minecraft

spigotのバージョンアップの事

spigotのバージョンアップさせたい場合は（もちろん、事前にデータディレクトリをバックアップして下さい）、 SPIGOT_VERSIONにそのバージョン番号を指定して起動するだけです。 指定されたバージョンのspigotがまだ生成されていなければ、自動的に生成を行います。

ともかく、うまくいく方法の例が知りたい、という事であれば、以下のようなスクリプトを用意しておいて、バージョンアップの時に使用すれば、古いバージョンのコンテナイメージの削除、spigotの新しいバージョンをビルド、そして再度systemdへの登録まで自動的にやってくれます。

upgrade.sh:

#!/bin/sh

systemctl stop container-minecraft
systemctl disable container-minecraft

podman rm minecraft

podman run --name minecraft -d -e SPIGOT_VERSION=$1 -e SPIGOT_OPTIONS=-Xms2048M -v /storage0/spigot-data:/spigot-data -p 25565:25565 docker.io/kekyo/spigot_runner

cd /etc/systemd/system
podman generate systemd --name --restart-policy on-failure -f minecraft
systemctl daemon-reload

systemctl enable container-minecraft

使い方:

$ chmod 755 upgrade.sh
$ sudo upgrade.sh 1.19.2

このスクリプトを元にして、カスタマイズすれば良いでしょう。

License

Under MIT.