Minecraftプラグインのインストール方法

手順

1. 1.サーバーがプラグインを動かせるか確認する

   プラグインには、Bukkit系のサーバーソフトウェアが必要です。ゲームサーバーならPaper、Spigot、Purpur、Folia、プロキシならBungeeCordかVelocityです。バニラのサーバーや、Fabric、Forgeのサーバーはプラグインを読み込みません。

2. 2.プラグインのバージョンを確認する

   プラグインのページやファイルに、対応するMinecraftのバージョンが書かれています。サーバーより新しいバージョン向けにビルドされたプラグインは、たいてい読み込みを拒否します。

3. 3.サーバーを止めて.jarをコピーする

   サーバーの.jarと同じ場所にあるplugins/フォルダに、.jarファイルを入れます。ホスティングのパネルなら、ファイルマネージャーかSFTPでアップロードします。解凍はしないでください。

4. 4.依存関係をインストールする

   プラグインがほかのプラグイン(Vault、PlaceholderAPI、ProtocolLib、LuckPerms)を必要とするなら、それらの.jarファイルもplugins/に入れます。

5. 5.サーバーを起動してコンソールを読む

   起動ログでプラグインの名前を探します。「Enabling <Plugin>」の後にエラーがなければ、読み込まれています。

6. 6.ゲーム内で確認して設定する

   /pluginsを実行します。読み込まれたプラグインは緑、有効化に失敗したプラグインは赤で表示されます。設定はplugins/<PluginName>/config.ymlにあるので、編集して再起動します。

ファイルの置き場所

プラグインを入れて初めて起動した後、一般的なサーバーフォルダは次のようになります。

• paper.jar(またはspigot.jar): サーバー本体。
• plugins/MyPlugin.jar: 追加したプラグイン。
• plugins/MyPlugin/: プラグインが作るフォルダ。config.yml、メッセージ、保存データが入ります。
• logs/latest.log: 現在の起動のログ。読み込みエラーはここに書かれます。

/reloadではなく再起動する

/reloadは、サーバーを再起動せずにすべてのプラグインをアンロードして読み込み直します。多くのプラグインはこれに対応していません。リスナーが二重に登録されたり、データが失われたり、メモリリークが起きたりします。プラグインを追加、削除、更新した後は、必ずサーバーを再起動してください。設定だけを読み込み直す独自のリロードコマンド(たとえば/myplugin reload)を持つプラグインもあり、そちらは安全に使えます。

本番サーバーにインストールする前に

• サーバーフォルダ、少なくともplugins/とワールドをバックアップします。
• まずコピーで試す: 本番サーバーと同じソフトウェア、バージョン、ほかのプラグインを使います。プラグインのテスト方法を参照してください。
• 1つずつ入れる: 何かが壊れても、どのプラグインが原因かわかります。
• 再アップロードされたものではなく、作者のページからダウンロードします(SpigotMC、Hangar、Modrinth、GitHub)。

Codexeで作ったプラグイン

Codexeで作ったプラグインは、プロジェクト名の付いたビルド済みの.jarとして届き、受け取る前にチェックされます。コンパイル済みのクラスとplugin.ymlが含まれていなければなりません。どこかにインストールする前に、専用のテストサーバーで試すことができ、どのプランでも無料です。テストサーバーは、依存関係として書かれたプラグインを自動でインストールします。自分のサーバー用に.jarをダウンロードするには、プランかダウンロードパックが必要です。

よくある質問