メインコンテンツまでスキップ

YAML 全設定一覧

EasyMenu 7で利用可能なすべての設定キーの完全リファレンスです。

ページ内検索(Ctrl + F または Cmd + F)で設定キー名を入力すれば、目的の設定とその仕様・詳細解説ページを素早く見つけることができます。


目次​

  1. メニュー全体設定
  2. アイテム要素設定 (menu-items)
  3. 表示設定 (presentation)
  4. アクション設定 (action / actions)
  5. 条件設定 (open-when / visible-when / enabled-when / when)
  6. 入力フォーム設定 (inputs)
  7. アイテムコンポーネント設定 (components)
  8. クールダウン設定 (cooldown)
  9. バリアント設定 (variants)
  10. 動的オープンコマンド設定 (open-command)

1. メニュー全体設定​

メニューファイル(main.yml、sub/*.yml)のルート直下に記述する設定です。

設定キー型初期値説明詳細解説ページ
menu-title文字列メニューIDメニュー上部に表示されるタイトル。& カラーコードやプレースホルダー対応。メニューの基本
menu-size数値54インベントリGUIのサイズ(スロット数)。9の倍数で 9〜54。範囲外はエラー(invalid-size)。インベントリGUI
menu-background-itemMaterial名GRAY_STAINED_GLASS_PANE空きスロットを埋める背景アイテム素材。none(または空)で無効化。未知の素材は警告のうえ既定値になります。メニューの基本
menu-opensoundSound名なしメニューが正常に開いた直後に再生される効果音。メニューの基本
menu-itemsリスト[]メニュー内に配置するアイテム(要素)の定義リスト。アイテムの設定
dialog真偽値なしtrue は presentation.mode: native-preferred の簡易記法。false はインベントリ表示の強制(runtime.default-presentation を上書き)。presentation と併記すると無視され警告。Native Dialog
presentationセクションruntime.default-presentation(既定: inventory)詳細な表示方式(インベントリ / Native Dialog / Rich UI)の設定。Body・Presentation
open-commandセクションなしこのメニュー専用のオープンコマンド定義(/shop 等)。メニューを開く
open-when条件常に許可このメニューを開くことができる条件判定。表示・使用条件
open-denied-message文字列言語ファイルopen-when で拒否された際にプレイヤーへ送信されるメッセージ。表示・使用条件
bodyリスト[]Native Dialog上部に表示する装飾コンテンツ(text / item)のリスト。インベントリGUIでは表示されません。Body・Presentation
inputsリスト[]メニュー全体で受け付ける名前付き入力フォームの定義リスト。入力
schema数値なし将来互換用のスキーマバージョン指定。EasyMenu 7.0.2 は読み取らず、書いても何も起きません。-

2. アイテム要素設定 (menu-items)​

menu-items: リスト内の各要素に記述する設定です。

設定キー型初期値説明詳細解説ページ
id文字列決定論的生成要素の識別ID。省略時は slot-13 や location-5-2 から自動決定。アイテムの設定
slot数値なしインベントリのスロット番号(0始まり)。0〜menu-size - 1 の範囲。範囲外・重複はエラー。アイテムの設定
location"列,行"なし1始まりのグリッド座標(例: "5,2")。列 1〜9、行 1〜menu-size ÷ 9。slot がある場合は slot 優先(警告)。アイテムの設定
materialMaterial名必須アイテムの素材名(例: DIAMOND, COMPASS)。アイテムの設定
name文字列素材名アイテムの表示名。カラーコードやプレースホルダー対応。アイテムの設定
lore文字列リスト[]アイテムの説明文(行のリスト)。Native Dialogではツールチップになります。アイテムの設定
amount数値1アイテムの個数(スタック数)。アイテムの設定
glint真偽値なしエンチャントの光沢効果を付与するかどうか。アイテムの設定
custom-model-data数値なしCustomModelData値(リソースパック用)。アイテムの設定
base64文字列なしPLAYER_HEAD に適用するカスタムスキンのBase64テクスチャ文字列。アイテムの設定
componentsセクション{}モダンアイテムコンポーネント設定(Minecraft 1.20.5+)。アイテムの設定
soundSound名なしクリックが受理された際に再生される効果音。メニュー・メッセージ・サウンド
close-menu真偽値trueアクション完了後にメニュー画面を閉じるかどうか。メニュー・メッセージ・サウンド
click-policy列挙型PRIMARY反応するクリック種類(PRIMARY, LEFT, RIGHT, ANY)。アクション概要
command文字列なし簡易アクション記法(プレイヤー権限のコマンド、sub_<id>, main_mainopen)。action / actions があるとそちらが優先され警告。コマンドを実行する
actionセクションなし単一の型付きアクション定義。actions と同時指定するとエラー。アクション概要
actionsリストなし順番に実行される複数アクションの定義リスト。空リスト [] は装飾専用アイテム。アクション概要
visible-when条件常に許可条件が false の場合、要素自体をメニューに表示しません。表示・使用条件
enabled-when条件常に許可条件が false の場合、表示されますがクリックを拒否します。表示・使用条件
disabled-message文字列言語ファイルenabled-when で拒否された際にプレイヤーへ送信されるメッセージ。表示・使用条件
cooldown時間/セクションなしアイテムクリックの再使用待機時間制限。クールダウン
variantsリスト[]プレイヤーの権限や条件に応じて見た目や動作を差し替えるバリアント定義。バリアント
input-refs文字列リスト[]アクション実行前に収集する inputs のIDリスト。入力

3. 表示設定 (presentation)​

メニュー全体の描画方式を制御する presentation: セクションの設定です。

設定キー型初期値説明詳細解説ページ
mode列挙型runtime.default-presentation(既定: inventory)表示モード(inventory, native-preferred, native-required, rich-preferred, rich-required, auto。別名 native / rich)。Body・Presentation
fallback真偽値true要求した表示モードで開けない場合に、次の描画方式へフォールバックするか。*-required は常にフォールバックしません。Body・Presentation
inventory.size数値54インベントリGUI時のスロット数。インベントリGUI
inventory.backgroundMaterial名GRAY_STAINED_GLASS_PANEインベントリGUI時の背景アイテム素材。インベントリGUI
native.columns数値3Native Dialog時のボタン列数(1〜8)。Bedrock Rich UIでは最大3列相当。Native Dialog
native.button-width数値150Native Dialog時のボタン横幅(1〜1024)。Bedrockでは3段階に丸められます。Native Dialog
native.can-close-with-escape真偽値trueESCキーでダイアログを閉じられるようにするか。Native Dialog
native.pause真偽値falseシングルプレイ時にゲームを一時停止するか。Native Dialog

4. アクション設定 (action / actions)​

クリック時に実行する12種類の型付きアクションのプロパティです。

アクション種別 (type)主な設定キー説明詳細解説ページ
commandcommand, executorplayer または console としてコマンドを実行。コマンドを実行する
player-commandcommandクリックしたプレイヤー自身としてコマンドを実行。コマンドを実行する
console-commandcommandサーバーコンソール(最高権限)としてコマンドを実行。コマンドを実行する
open-menumenu指定したメニューIDを開く(描画完了まで待機)。メニュー・メッセージ・サウンド
close-menuなし操作元のメニュー画面を閉じる。メニュー・メッセージ・サウンド
messagemessageプレイヤーにチャットメッセージを送信。メニュー・メッセージ・サウンド
soundsound, volume, pitchプレイヤーに効果音を再生。メニュー・メッセージ・サウンド
titletitle, subtitle, fade-in, stay, fade-out画面中央にタイトル・サブタイトルを表示。メニュー・メッセージ・サウンド
teleportworld, x, y, z, yaw, pitch, reset-velocity, no-fall-ticks(既定 0)。safe は読み込まれますが効果なしプレイヤーを指定ワールド・座標へテレポート。高度なアクション
delayduration指定時間(例: 3s, 500ms)だけ後続アクションを非同期待機。高度なアクション
potion-effecteffect, duration, amplifier, ambient, particlesプレイヤーにステータス効果(ポーション効果)を付与。高度なアクション
inputprompt, input-type(string / integer / decimal), min, max, timeout-seconds, variable, command, actionsチャットで入力を受け付けてから処理を継続。command には {変数名}(既定 {input})が必須。高度なアクション

5. 条件設定 (open-when / visible-when / enabled-when / when)​

アクセス制御や条件分岐で使用する条件キーと演算子です。

条件キー設定値の型説明詳細解説ページ
permission文字列プレイヤーが指定した権限を持っているか判定。条件に文字列だけを書いた場合も同じ扱い。条件
world文字列 / リスト / セクションプレイヤーのワールド判定(in, not-in 対応)。条件
gamemode文字列 / リストゲームモード(SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR)判定。条件
placeholderセクションPlaceholderAPI の値と比較(value, operator, compare)。条件
allリストすべての条件を満たす場合に成立(AND)。条件
anyリストいずれかの条件を満たす場合に成立(OR)。条件
not条件指定した単一条件の結果を反転(NOT)。条件

比較演算子 (placeholder.operator)​

==, !=, >, >=, <, <=, contains, not-contains, starts-with, ends-with(別名: =, eq, equals, <>, ne, not-equals, gt, ge, gte, lt, le, lte)

条件には、文字列(権限)、true / false、複数キーの暗黙の all も書けます。詳しくは 条件 を参照してください。


6. 入力フォーム設定 (inputs)​

メニュー全体の inputs: リストで宣言するフォーム入力フィールドの設定です。

設定キー型初期値説明詳細解説ページ
id文字列必須入力フィールドの識別ID({input.<id>} で参照)。入力
type列挙型text入力タイプ(text, integer, decimal, boolean, option)。type: input アクションの型とは別です。入力
label文字列id の値プレイヤーに提示する入力ラベル(プロンプト文言)。入力
min数値なしinteger / decimal の最小値。入力
max数値なしinteger / decimal の最大値。入力
max-length数値128text / integer / decimal の入力文字数上限。数値は通常表記への変換後の長さも制限。入力
initial各種型なしフィールドの初期値(入力条件を満たしている必要があります)。入力
optionsリスト[]option 選択肢の定義リスト(id と display を含む)。入力
timeout-seconds数値input.default-timeout-seconds(既定 60)入力待ちのタイムアウト秒数。0 以下はエラー。入力

7. アイテムコンポーネント設定 (components)​

アイテムの components: セクションで指定するモダンコンポーネント設定です。

設定キー型説明詳細解説ページ
unbreakable真偽値アイテムの耐久度を無限にするかどうか。アイテムの設定
max-stack-size数値アイテムの最大スタック数(1〜99)。アイテムの設定
damage数値アイテムの現在の耐久消費値。アイテムの設定
max-damage数値アイテムの最大耐久値。アイテムの設定
repair-cost数値金床での修繕コスト。アイテムの設定
rarity列挙型レアリティ(common, uncommon, rare, epic)。アイテムの設定
item-model文字列1.21.6+ のアイテムモデル識別子(例: minecraft:bundle)。アイテムの設定
hide-tooltip真偽値アイテムのツールチップを非表示にするかどうか。アイテムの設定
enchantment-glint-override真偽値エンチャント光沢の強制有効/無効化。アイテムの設定

8. クールダウン設定 (cooldown)​

アイテムのクリック間隔を制御する cooldown: セクションの設定です。

設定キー型初期値説明詳細解説ページ
duration時間文字列必須クールダウン時間(500ms, 5s, 1m, 1h, 40t 等。単位なしは秒)。クールダウン
bypass-permission文字列なしクールダウンを免除するバイパスパーミッションノード。クールダウン
message文字列言語ファイルクールダウン中にクリックした際のメッセージ({remaining} 展開対応)。クールダウン
key文字列なし複数アイテムでクールダウンを共有するためのグループ識別子。クールダウン

9. バリアント設定 (variants)​

条件に応じてアイテムを動的に差し替える variants: リストの設定です。

設定キー型初期値説明詳細解説ページ
id文字列variant-<番号>バリアントの識別ID。省略可。バリアント
when条件常に成立このバリアントを適用するための成立条件。バリアント
overrideセクション必須成立時に上書きするアイテム設定(name, lore, material, command 等)。バリアント

10. 動的オープンコマンド設定 (open-command)​

メニュー専用のサーバーコマンドを登録する open-command: セクションの設定です。

設定キー型初期値説明詳細解説ページ
name文字列必須登録するメインコマンド名(例: shop)。英数字・_・- のみ、32文字以内。メニューを開く
aliases文字列リスト[]コマンドの別名(エイリアス)リスト。メニューを開く
permission文字列なしコマンド実行に必要なパーミッションノード。メニューを開く
permission-default真偽値false既定許可対象。true で全員に許可、false でOPのみに許可。メニューを開く