help.ymlの設定

help.ymlは/helpコマンドを実行した際の出力を追加したり変更するためのファイルです。

この記事ではSpigot 1.13.2で動作確認を行っています。バージョンによっては設定ファイルの設定項目が異なることもあるでしょう。

general-topics

general-topicsでは文字などを表示するトピックを作成できます。

general-topics:
  Rules:
    shortText: このサーバーのルール
    fullText: |
      &61. 仲良くしましょう
      &B2. 嫌がらせをしない
      &D3. 言葉遣いに気を付ける      
    permission: topics.rules

Rulesの部分はトピック名です、実際に設定したいトピック名を設定しましょう。空白も使えます。

shortTextはトピックの簡単な説明を設定します。これは/helpを使用した際の一覧などで表示されます。

fullTextはトピックを閲覧した際に表示されるメッセージです。改行などはBukkitが自動的に処理します。

permissionはトピックを見るために必要なパーミッションです。空(permission: [])を設定するとすべてのユーザーが閲覧可能になります。

index-topics

index-topicsでは文字情報を表示する代わりに、コマンドなどを一覧で表示できます。

ちなみに/helpを引数なしで実行した際に表示されるものもインデックストピックであり、これはDefaultというトピック名で上書きできます。

index-topics:
  Ban Commands:
    shortText: BANコマンド
    preamble: モデレーター - 悪用厳禁
    permission: op
    commands:
      - /ban
      - /ban-ip
      - /banlist
      - Rules

Ban Commandsの部分はトピック名です。先の通りDefaultでデフォルトのトピックを上書きできます。

shortTextはあるインデックストピックが別のインデックストピックに含まれているときに表示されるトピックの簡単な説明です。

preambleはトピックを閲覧した際に最初の行に表示されるメッセージです。

permissionはトピックを見るために必要なパーミッションです。空(permission: [])を設定するとすべてのユーザーが閲覧可能になります。

commandsはこのトピックに含めるコマンドの一覧です。他のトピックを含めることも可能です。

amended-topics

amended-topicsは自動生成されたトピックの内容を変更できます。

amended-topics:
  /stop:
    shortText: サーバーを停止させる
    fullText: <text> - サーバーを停止させる
    permission: server.administrator

/stopの部分はトピック名です。これはヘルプトピックを表示する際に使用される名前と正確に一致する必要があります。

shortTextは新たに置き換えるテキストです。<text>と指定することで元のトピックのテキストを挿入できます。

fullTextも同様に、新たに置き換えるテキストで、<text>と指定することで元のトピックのテキストを挿入できます。

permissionも新たに設定するパーミッションです。空白のままにすることもできます。

ignore-plugins

ignore-pluginsにプラグイン名を指定するとトピックが自動生成されなくなります。

ignore-plugins:
 - PluginName
 - Bukkit
 - All

Bukkitと指定するとBukkitコマンドのトピックが自動生成されなくなり、Allと指定するとすべてのトピックが自動生成されなくなります。

トピックの自動生成はそのままに、デフォルトのインデックストピックに含めたくない場合はcommand-topics-in-master-indexをfalseに設定します。

command-topics-in-master-index: false

トピックはそのまま存在し、/helpで閲覧でき、index-topicsにも含められますが、デフォルトのインデックストピックには表示されなくなります。

色コード

テキストに色を付けたり装飾を施したりするためには色コードを使用します。

具体的に言えば&の後に英数字を付けることで該当の色コードに変換されます。色コードの一覧は次の通りです。

参考

• Help.yml - Official BukkitWiki (公式wiki、英語)