BungeeCordプラグインの作り方

手順

1. 1.使っているプロキシを確認する

   BungeeCord(またはWaterfallなどのフォーク)とVelocityは、別々のAPIです。BungeeCordプラグインはVelocityでは動かず、その逆も同じです。

2. 2.プロジェクトを用意する

   MavenまたはGradleのプロジェクトで、bungeecord-apiの依存関係をprovidedスコープで追加します。実行時にはプロキシが提供します。

3. 3.メインクラスを書く

   net.md_5.bungee.api.plugin.Pluginを継承するクラスを作り、onEnable()で、getProxy().getPluginManager()を通じてコマンドとリスナーを登録します。

4. 4.bungee.ymlに記述する

   name、version、main、author。BungeeCordはplugin.ymlも読み込みますが、bungee.ymlにすればSpigotプラグインと紛らわしくなりません。コマンドはファイルではなくコードで登録します。

5. 5.コマンドとリスナーを書く

   コマンドはCommandを継承し、リスナーはListenerを実装して、PostLoginEventやServerSwitchEventなどのイベント用に@EventHandlerメソッドを持たせます。

6. 6.必要ならバックエンドサーバーとやり取りする

   プロキシからはインベントリやワールドが見えません。それが必要なら、各バックエンドサーバーに小さな補助プラグインを置き、プロキシプラグインとプラグインメッセージをやり取りします。

7. 7.プロキシにインストールする

   .jarをプロキシのplugins/フォルダに入れ、バックエンドサーバーではなくプロキシを再起動します。

便利なプロキシのイベント

ネットワークを正しく設定する

• プロキシのconfig.ymlでip_forwardを有効にし、各SpigotまたはPaperサーバーのspigot.ymlでbungeecord: trueにします。これで、プレイヤー名とUUIDが引き継がれます。
• バックエンドサーバーをonline-mode=falseにし、インターネットから直接ではなく、プロキシ経由でしか接続できないようにします。
• プラグインメッセージは、プレイヤーがそのバックエンドサーバーに接続している間しか届きません。誰もいないサーバーへのメッセージは配信されません。

説明の例

「NetUtilsという名前のBungeeCord 1.21プロキシプラグイン。/lobbyでプレイヤーをロビーサーバーに送る。/staffchat <message>(エイリアス/sc)で、どのサーバーにいてもnetutils.staffを持つ全員にメッセージを送る。/maintenance on|offでメンテナンス用のMOTDを表示し、netutils.bypassを持たないプレイヤーをキックする。スタッフがサーバーを移動するとスタッフチャットに参加メッセージ。サーバー名、MOTD、メッセージはconfig.ymlに置く。」

Codexeで

BungeeCord/Velocityタイプを選び、使っているプロキシを書いてください。この2つは別々のAPIです。CodexeはMavenでプラグインをコンパイルし、準備完了になる前に、.jarに正しい記述ファイルがあるか確認します。リクエストにバージョンがなければ、BungeeCord API 1.21が使われます。バックエンド用の補助プラグインが必要なら、別のSpigot/Paperプロジェクトとして依頼してください。

「今すぐ試す」はまだプロキシサーバーに対応していないので、プロキシプラグインは自分のネットワークか、バックエンドサーバー1台を付けたローカルのプロキシでテストしてください。BungeeCordプラグインジェネレーターも参照してください。

よくある質問