Foliaプラグインの作り方

手順

1. 1.本当にFoliaが必要か確認する

   Foliaが役に立つのは、プレイヤーが多く、ワールド中に散らばっているサーバーです。ほとんどのサーバーはPaperで動いていて、人気のプラグインの多くはFoliaに対応していません。まず、頼りにしているプラグインを確認してください。

2. 2.Folia APIに対してビルドする

   MavenまたはGradleのプロジェクトで、PaperMCのリポジトリから、バージョンに合ったfolia-apiの依存関係をprovidedスコープで使います。

3. 3.Bukkitスケジューラーを置き換える

   Bukkit.getScheduler()はFoliaでは動きません。特定の場所での処理にはリージョンスケジューラー、プレイヤーやモブに対する処理にはエンティティスケジューラー、ワールド全体のタスクにはグローバルリージョンスケジューラー、I/Oには非同期スケジューラーを使います。

4. 4.対象には、そのリージョンからだけ触れる

   ブロックやエンティティは、それを持っているスレッドでだけ変更します。teleportの代わりにteleportAsyncを使い、変更する前に対象のリージョンにタスクをスケジュールします。

5. 5.Folia対応を宣言する

   plugin.ymlにfolia-supported: trueを追加します。これがないと、Foliaはプラグインの読み込みを拒否します。

6. 6.Foliaサーバーでテストする

   コンパイルできても、Folia APIに対してビルドできることがわかるだけで、スレッドセーフであることの証明にはなりません。複数のプレイヤーが別々の場所にいる状態で、Foliaのテストサーバーで動かしてください。

4つのスケジューラー

よく壊れるところ

• 全プレイヤー向けの繰り返しタスク: オンラインの全プレイヤーを1つのループで回す方法はもう使えません。代わりに、各プレイヤーのエンティティスケジューラーにタスクをスケジュールします。
• テレポートと待機時間: 「3秒後にテレポート」には、エンティティスケジューラーとteleportAsyncが必要です。
• 共有データ: 複数のリージョンから使うマップやカウンターは、並行コレクションなど、スレッドセーフでなければなりません。
• 依存関係: Bukkitスケジューラーを呼び出すライブラリは、FoliaではUnsupportedOperationExceptionを投げます。

PaperとFoliaに1つのプラグインで対応する

リージョン、エンティティ、グローバル、非同期の各スケジューラーは、現在のバージョンではPaper APIにも含まれています。そのため、これらだけを使い、folia-supported: trueを宣言したプラグインは、PaperでもFoliaでも動きます。多くの場合、これが最適な対象です。1つの.jarでどのサーバーにも対応できます。

Codexeで

Foliaタイプを選びます。生成されるプラグインは、リージョン、エンティティ、グローバルリージョン、非同期の各スケジューラーで処理をスケジュールし、folia-supported: trueを宣言し、MavenでFolia APIに対してビルドされます。準備完了になる前に、コンパイルとチェックが行われます。

タイミングの詳細(「オンラインの各プレイヤーに1分ごと」「3秒後にテレポート」)をリクエストに書いてください。Foliaのコードが最も違ってくるのはそこです。「今すぐ試す」はまだFoliaサーバーに対応していないので、.jarは自分のFoliaサーバーでテストしてください。

よくある質問