Minecraftのプラグインの作り方

手順

1. 1.サーバーソフトウェアとバージョンを選ぶ

   プラグインは、Bukkitベースのサーバー(Spigot、Paper、Folia。プロキシならBungeeCordとVelocity)で動きます。サーバーで動いているMinecraftのバージョンを、1.8〜26.xから選んでください。

2. 2.プラグインの動作を説明する

   コマンド、権限、ゲーム内で起こること、設定できるようにしたいことを書きましょう。例: 「/sethome、/home、/delhome、1人あたり最大3つのホーム、3秒の待機、メッセージはconfig.yml」。

3. 3.Codexeに書いてコンパイルさせる

   Codexeは、Javaのクラス、plugin.yml、config.yml、pom.xmlを書き、本物のビルドを実行して、プロジェクトを準備完了にする前にコンパイルエラーを修正します。

4. 4.本物のサーバーでテストする

   「今すぐ試す」を押すと、プラグインがインストールされた専用のMinecraftサーバーに参加できます。Codexeのテストプレイヤーがすべてのコマンドを実行して、依頼した内容を確認します。

5. 5..jarをダウンロードしてインストールする

   ビルドされた.jarをダウンロードして、サーバーのplugins/フォルダに入れ、サーバーを再起動します。設定ファイルは、plugins/<PluginName>/に作成されます。

Minecraftのプラグインとは

プラグインは、Minecraftサーバーがplugins/フォルダから読み込む.jarファイルです。コマンド、ゲームのルール、エコノミー、ミニゲームなど何でも、サーバー側だけに追加します。プレイヤーは通常のゲームで参加でき、MODは不要です。

プラグインは、サーバーAPI(ゲームサーバーならSpigotとPaper、プロキシならBungeeCordとVelocity)向けに、Java(またはKotlin)で書かれます。プラグインには、サーバーに名前、メインクラス、コマンド、権限を伝えるplugin.ymlも必要です。

手作業の方法: Java、Maven、SpigotまたはPaper API

習得に時間はかかりますが、完全に制御できます。Codexeも同じ種類のプロジェクトを出力するので、生成されたプラグインから始めて、手作業で続けることもできます。

1. JDK(1.20.5〜1.21.xはJava 21、26.xはJava 25)と、IntelliJ IDEAなどのIDEをインストールします。
2. MavenまたはGradleのプロジェクトを作り、バージョンに合ったpaper-apiまたはspigot-apiの依存関係を、providedスコープで追加します。
3. JavaPluginを継承するメインクラスを書き、onEnable()とonDisable()を用意します。
4. src/main/resourcesにplugin.ymlを追加し、name、version、main、api-version、コマンドを書きます。
5. getCommand("name").setExecutor(...)でコマンドを、getServer().getPluginManager().registerEvents(...)でリスナーを登録します。
6. mvn packageでビルドし、target/の.jarをテストサーバーのplugins/フォルダにコピーして、再起動します。

よくある質問