PlaceholderAPI ― Minecraftで動的データを埋め込むプラグイン

PlaceholderAPI ― Minecraftで動的データを埋め込むプラグイン

• この記事を検証・執筆した際のMinecraftバージョン: 26.1.2

• 対応バージョンの範囲: 1.8.x – 26.1.x

PlaceholderAPI(略称PAPI)は、テキスト内の特殊なマーカーを動的な値に置き換えるMinecraft用のサーバープラグインです。これ自体は何も出力しません。文字列の中から%player_name%のようなマーカーを見つけ、それをプレイヤー名、残高、ランク、サーバーのオンライン人数といった実際の値に置き換えるエンジンです。データそのものは個別のモジュール(拡張機能)が提供し、PAPIは置き換えだけを行います。これにより、チャット、スコアボード、タブリスト、メニューの各プラグインが独自の記法を持たずに、同じ形式で値を読み込めるようになります。

プレースホルダーの形式

プレースホルダーは2つのパーセント記号の間に記述します: %<розширення>_<параметр>%。アンダースコアより前の部分が拡張機能名、その後が具体的なパラメータです。例えば、%player_name%はプレイヤー名を返し、%server_online%はオンラインのプレイヤー数を返します。

置き換えが行われるのは、それを呼び出す受信側のプラグインがある場合のみです。プラグインがPAPIに対応していない場合、そのメッセージ内のマーカーは通常のテキストのまま残ります。個々のプレースホルダーは解析コマンドで確認できます:

/papi parse me %player_name%

応答としてマーカーのテキストそのものが返され、値が返されない場合は、該当する拡張機能が存在しないか、拡張元のプラグインが無効になっています。

拡張機能とeCloud

PlaceholderAPIには標準では1つのプレースホルダーも含まれておらず、すべて拡張機能から提供されます。一部は拡張元のプラグインに組み込まれており、サーバー起動時に自動的に登録されます。それ以外は個別のjarファイルとして拡張機能クラウド(eCloud)に置かれており、/plugins/PlaceholderAPI/expansions/ディレクトリにインストールします。

必要な拡張機能はゲーム内から直接ダウンロードできます:

/papi ecloud download <розширення>

/papi reload

このコマンドでダウンロードできるのは検証済みの拡張機能のみです。これは悪意のあるコードからの保護です。未検証の拡張機能は手動で導入します。サイトからjarファイルをダウンロードし、拡張機能用のディレクトリに配置してください。

コマンド

すべてのコマンドは/papiから始まります。デフォルトではオペレーターのみが使用でき、個別の権限はplaceholderapi.*ノードを通じて付与されます。

設定

config.ymlで編集する価値があるのは、わずかなパラメータだけです:

ファイル内の残りの値はシステム用(拡張機能の保護、Adventureコンポーネントでの置換モード、デバッグ)で、デフォルトのままにしておきます。

まとめ

PlaceholderAPIは、何百ものプラグインが理解できる単一のデータ置換フォーマットを提供します。プラグインごとに個別の連携を実装する代わりに、プレースホルダーを含む1行を書くだけで済みます。チャット、タブリスト、スコアボード、メニューを動的データで運用するMinecraftサーバーの管理者にとって必要なものであり、シングルプレイでは活用の余地がありません。