NegiLib 設定ガイド
plugins/NegiLib/config.yml は、EasyMenuの描画基盤 NegiLib 1.1.1 の設定ファイルです。
EasyMenuの設定(plugins/EasyMenu/config.yml)とは別のファイルです。多くの環境では、既定のまま変更する必要はありません。
NegiLibの config.yml はサーバー起動時に読み込まれます。/menu reload では再読込されません。
変更後は、サーバーを再起動してください。ただし resource-packs の中身だけは /negilib reload で再解析できます(後述)。
既定の設定
debug: false
resource-packs: []
appearance-workers: 2
java-pack-url: ""
java-pack-sha1: ""
bedrock:
rich-ui: auto
| キー | 型 | 既定値 | 説明 |
|---|---|---|---|
debug | 真偽値 | false | 描画方式の選択やセッションの出来事をログに出す。 |
resource-packs | 文字列リスト | [] | アイテム画像の解決に使うResource Packの層。 |
appearance-workers | 整数 | 2 | アイテム画像の解析・生成に使うスレッド数。 |
java-pack-url | 文字列 | "" | 生成したJava向けPackを置いたURL。 |
java-pack-sha1 | 文字列 | "" | 上記Packの SHA-1(40桁の16進数)。 |
bedrock.rich-ui | 文字列 | auto | Bedrock向けRich UIの利用を許可するか。auto または off。 |
debug
true にすると、メニューを開いたときにどの描画方式(レンダラー)が選ばれたか、セッションの開始・終了、拒否された操作などがログに出力されます。
動作を調べるときだけ有効にしてください。
EasyMenu側のデバッグ(plugins/EasyMenu/config.yml の debug)とは別の設定です。
resource-packs
アイテムの画像(アイコン)を解決するときに参照する、追加のResource Packを指定します。サーバーのリソースパックと混同しないでください。NegiLib自身が、アイテム画像を合成するために読み込むものです。
resource-packs:
- packs/base.zip
- packs/my-custom-textures
- 指定するのは、
plugins/NegiLib/からの相対パスです。ZIPファイルまたはフォルダを指定できます。 - 後ろに書いたものほど優先度が高くなります。
plugins/NegiLib/の外を指す指定(..を使うなど)は拒否され、エラーログが出ます。- Packの読み込みには上限があります(ファイル数 100,000、展開後の合計 512 MiB、1ファイル 32 MiB、画像の辺 4096px など)。上限を超えるPackは拒否され、以前の状態が維持されます。
- 何も指定しない(空)場合も、バニラのアイテムは標準の表現で表示されます。
指定したPackの内容を変更したあとは、サーバーを再起動せずに /negilib reload(プレイヤーとして実行、negilib.admin が必要)で再解析できます。新しいPackは、完全に解析できたときだけ有効になります。
appearance-workers
アイテムの画像を解析・生成するバックグラウンドのスレッド数です。メニューのクリック処理やメインスレッドとは別に動きます。
通常は 2 のままで構いません。カスタムアイコンが非常に多い環境で、初回表示が遅い場合に増やしてください。1 未満の値は 1 として扱われます。
java-pack-url / java-pack-sha1
NegiLibは、カスタムのアイテム画像をJava版クライアントへ表示するため、生成したJava向けResource Pack(plugins/NegiLib/generated/negilib-java.zip)を作ります。
このPackをプレイヤーに配るには、運営者がそのZIPをHTTP(S)で公開し、URLを設定します。NegiLib自身がファイルを配信するわけではありません。
java-pack-url: "https://example.com/negilib-java.zip"
java-pack-sha1: "0123456789abcdef0123456789abcdef01234567"
java-pack-urlは、httpまたはhttpsで始まる絶対URLにします。不正な値のときは警告が出て、Packの配布は無効になります。java-pack-sha1は、公開したZIPの SHA-1 です。40桁の16進数でない場合は警告が出て、生成されたPackのリビジョンが決まるまで配布が待たれます。- 生成されたPackの内容が更新されると、NegiLibはオンラインのプレイヤーへ更新後のPackを送り直します。
- カスタムのアイテム画像は、そのプレイヤーが現在のリビジョンのPackを適用済みのときだけ使われます。未適用のときは、確認できた標準の表示、または文字だけのラベルに切り替わります。
- この設定はオプションです。 空欄なら、NegiLibはPackを送信しません。サーバーやプロキシが別の仕組みでPackを配る場合は、空欄のままにしてください。
bedrock.rich-ui
Bedrock版プレイヤー向けのRich UIの利用を許可するかを決めます。
| 値 | 動作 |
|---|---|
auto(既定) | Rich UI用のPackを、Geyser経由の新しいBedrock接続に登録します。 |
off | Rich UIを使いません。常に通常のBedrockフォーム(SimpleForm)になります。 |
off 以外の値は auto と同じ扱いです。
この設定は、メニュー側の表示モード(presentation.mode など)を変えるものではありません。メニューが inventory のままなら、auto でもRich UIは使われません。詳しくは Bedrock / Geyser / Rich UI ガイド を参照してください。
2つのPackの違い
NegiLibが扱うPackは、用途の異なる別のものです。
| Java向けResource Pack | Bedrock Rich UI Pack | |
|---|---|---|
| 目的 | カスタムのアイテム画像をJava版クライアントに表示する | Bedrock版クライアントにRich UIの画面を表示する |
| 内容 | アイテム画像を生成した、Java版のResource Pack(negilib-java.zip) | BedrockのJSON UIを定義したResource Pack(negilib-bedrock-ui.mcpack、現在のリビジョンは negilib-rich-ui-v11) |
| 配り方 | 運営者がURLで公開し、java-pack-url / java-pack-sha1 を設定する | Geyserのセッション登録で自動的に配られる。設定は不要 |
| 設定 | java-pack-url、java-pack-sha1、resource-packs | bedrock.rich-ui |
| 無効にするには | java-pack-url を空にする | bedrock.rich-ui: off |
resource-packs は、上のどちらでもなく、アイテム画像を作るための材料を足す設定です。
Rich UI Packを登録できても、クライアントが正しく表示できたことの確認にはなりません。端末ごとの確認が必要です(Bedrock ガイド)。