plugin.yml ガイド
plugin.yml は、Spigot、Paper、Bukkit サーバーでプラグインをロードするために必要な設定ファイルです。このツールは、プラグインの動作を定義する YAML 形式のファイルを生成するのに役立ちます。
name、main、version の各フィールドは必須です。name はプラグインの一意の識別子であり、英数字とアンダースコアのみを使用する必要があります。main はプラグインのメインクラスへの完全なパスであり、version はプラグインのバージョン番号です。
オプションのメタデータフィールドには、description、author、authors、contributors、website、prefix、load、api-version などがあります。これらはプラグインに関する追加情報を提供し、サーバーがプラグインをロードする方法に影響を与える可能性があります。
コマンドとパーミッションは、プラグインが提供する機能と、それらの機能にアクセスできるユーザーを定義するために使用されます。各コマンドには、名前、説明、使用法、パーミッション、およびパーミッションメッセージを設定できます。パーミッションには、ノード、説明、デフォルト値、および子パーミッションを設定できます。
よくある質問
plugin.yml ファイルはどこに置けばよいですか？
生成された plugin.yml ファイルは、プラグインの JAR ファイル内のルートディレクトリに配置する必要があります。通常、これはプラグインのビルドプロセスによって自動的に処理されます。
「Spigot requires name to use only letters, numbers, and underscores (a-z A-Z 0-9 _).」というエラーが表示されるのはなぜですか？
これは、プラグイン名に無効な文字が含まれていることを意味します。Spigot は、プラグイン名に英数字とアンダースコアのみを許可します。スペース、ハイフン、その他の特殊文字は使用できません。
複数の作者や貢献者を指定するにはどうすればよいですか？
「authors」フィールドまたは「contributors」フィールドに、カンマ区切りの名前リストを入力します。「authors」フィールドは「author」フィールドを上書きします。
コマンドのエイリアスを追加するにはどうすればよいですか？
コマンドの「aliases」フィールドに、カンマ区切りのエイリアスリストを入力します。たとえば、「mycommand, mc」と入力すると、「mycommand」と「mc」の両方でコマンドが実行されます。