Minecraftのエコノミープラグインの作り方

手順

1. 1.プラグインの役割を決める

   プラグイン自体がエコノミーになる(残高を保存し、Vaultのエコノミーとして自分を登録する)か、Vaultを通じて既存のエコノミーを使う(ショップ、賞金首、ジョブのプラグインなど)かのどちらかです。ほとんどのサーバーに必要なのは、それぞれ1つずつで、エコノミーを2つ入れることではありません。

2. 2.サーバーとバージョンを決める

   サーバーソフトウェアとバージョンを書きます。例: Paper 1.21.4。プラグインはそのバージョンのAPIとJavaのレベルに合わせてビルドされます。

3. 3.コマンドとルールを書き出す

   /balance、/pay <player> <amount>、/baltop、そして/eco give|take|setなどの管理者コマンド。初期残高、通貨名、小数点以下の桁数、最低支払額も加えます。

4. 4.残高の保存先を選ぶ

   サーバーが1台ならSQLite、複数のサーバーで同じ残高を共有するならMySQLです。お金は再起動やクラッシュでも消えてはいけないので、メモリだけに保持することはありません。

5. 5.Codexeに書いてビルドさせる

   プラグインの内容を説明し、依存関係として追加されるようにVaultの名前をはっきり書きます。CodexeがJavaのコード、plugin.yml、config.ymlを書き、コンパイルして、プロジェクトが準備完了になる前にビルドエラーを修正します。

6. 6.ゲーム内で支払いをテストする

   「今すぐ試す」を押してテストサーバーに参加します。2つのアカウント間で支払い、大きすぎる額、マイナスの額、数字でない値を試したら、再起動して残高が残っているか確認します。

7. 7.インストールする

   Vaultとあなたの.jarをサーバーのplugins/フォルダに入れて再起動します。ほかのエコノミープラグインは外すか、Vaultがどれを使うかを決めておきます。

Vaultの役割

Vaultはエコノミーではなく、橋渡し役です。エコノミープラグインはVaultのEconomyインターフェースを実装し、サーバーのサービスマネージャーに登録します。ほかのプラグインはgetServer().getServicesManager().getRegistration(Economy.class)でそれを取得し、getBalance、withdrawPlayer、depositPlayerなどのメソッドを呼び出します。

そのため、ショップのプラグインは、どのエコノミーが動いているかを知る必要がありません。plugin.ymlでは、Vaultなしでは動かないプラグインならdepend: [Vault]、Vaultが任意ならsoftdependを使います。Vault APIはコンパイルにだけ必要で、Vault本体はサーバーにインストールします。

リクエストに書いておくべきこと

• お金の表示形式: 通貨名の単数形と複数形、記号、小数点以下の桁数。
• 上限: 初期残高、最大残高、残高がマイナスになってもよいか。
• オフラインのプレイヤー: オンラインでないプレイヤーにも/payと/ecoが使えるか。
• ログ: データベースやファイルへの取引ログ。スタッフがトラブルを確認できるようにします。
• お金の稼ぎ方: モブを倒す、プレイ時間の報酬、アイテムの売却、または管理者コマンドのみ。

残高の保存先

説明の例

「Vaultのエコノミーとして自分を登録する、Coinsという名前のPaper 1.21.4エコノミープラグイン。/balance [player]、最低1の/pay <player> <amount>、上位10人の/baltop、coins.adminを持つプレイヤー向けの/eco give|take|set。新規プレイヤーは100コインからスタート。小数点以下2桁。すべての支払いを日付、送り手、受け手、金額とともに記録。残高はSQLiteに保存。通貨名とすべてのメッセージはconfig.ymlに置く。」

ほかに指定がなければ、CodexeはデフォルトでSQLiteを使います。MySQLを指定すると、プラグインはstorage-type設定付きで書かれ、試している間はテストサーバーが専用のMySQLデータベースを用意します。

よくある質問