YAML 全設定一覧
EasyMenu 7で利用可能なすべての設定キーの完全リファレンスです。
ページ内検索(Ctrl + F または Cmd + F)で設定キー名を入力すれば、目的の設定とその仕様・詳細解説ページを素早く見つけることができます。
目次
- メニュー全体設定
- アイテム要素設定 (
menu-items) - 表示設定 (
presentation) - アクション設定 (
action/actions) - 条件設定 (
open-when/visible-when/enabled-when/when) - 入力フォーム設定 (
inputs) - アイテムコンポーネント設定 (
components) - クールダウン設定 (
cooldown) - バリアント設定 (
variants) - 動的オープンコマンド設定 (
open-command)
1. メニュー全体設定
メニューファイル(main.yml、sub/*.yml)のルート直下に記述する設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
menu-title | 文字列 | メニューID | メニュー上部に表示されるタイトル。& カラーコードやプレースホルダー対応。 | メニューの基本 |
menu-size | 数値 | 54 | インベントリGUIのサイズ(スロット数: 9, 18, 27, 36, 45, 54)。 | インベントリGUI |
menu-background-item | Material名 | GRAY_STAINED_GLASS_PANE | 空きスロットを埋める背景アイテム素材。none で無効化。 | メニューの基本 |
menu-opensound | Sound名 | なし | メニューが正常に開いた直後に再生される効果音。 | メニューの基本 |
menu-items | リスト | [] | メニュー内に配置するアイテム(要素)の定義リスト。 | アイテムの設定 |
dialog | 真偽値 | false | presentation.mode: native-preferred の簡易記法。対応環境でNative Dialog表示。 | Native Dialog |
presentation | セクション | mode: inventory | 詳細な表示方式(インベントリ / Native Dialog)の設定。 | Body・Presentation |
open-command | セクション | なし | このメニュー専用のオープンコマンド定義(/shop 等)。 | メニューを開く |
open-when | 条件 | 常に許可 | このメニューを開くことができる条件判定。 | 表示・使用条件 |
open-denied-message | 文字列 | 言語ファイル | open-when で拒否された際にプレイヤーへ送信されるメッセージ。 | 表示・使用条件 |
body | リスト | [] | Native Dialog上部に表示する装飾コンテンツ(テキスト・アイテム)のリスト。 | Body・Presentation |
inputs | リスト | [] | メニュー全体で受け付ける名前付き入力フォームの定義リスト。 | 入力 |
schema | 数値 | なし | 将来互換用のスキーマバージョン指定(解析時は無視されます)。 | - |
2. アイテム要素設定 (menu-items)
menu-items: リスト内の各要素に記述する設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
id | 文字列 | 決定論的生成 | 要素の識別ID。省略時は slot-13 や location-5-2 から自動決定。 | アイテムの設定 |
slot | 数値 | なし | インベントリのスロット番号(0始まり、0〜53)。 | アイテムの設定 |
location | "列,行" | なし | 1始まりのグリッド座標(例: "5,2")。slot がある場合は slot 優先。 | アイテムの設定 |
material | Material名 | 必須 | アイテムの素材名(例: DIAMOND, COMPASS)。 | アイテムの設定 |
name | 文字列 | 素材名 | アイテムの表示名。カラーコードやプレースホルダー対応。 | アイテムの設定 |
lore | 文字列リスト | [] | アイテムの説明文(行のリスト)。Native Dialogではツールチップになります。 | アイテムの設定 |
amount | 数値 | 1 | アイテムの個数(スタック数)。 | アイテムの設定 |
glint | 真偽値 | なし | エンチャントの光沢効果を付与するかどうか。 | アイテムの設定 |
custom-model-data | 数値 | なし | CustomModelData値(リソースパック用)。 | アイテムの設定 |
base64 | 文字列 | なし | PLAYER_HEAD に適用するカスタムスキンのBase64テクスチャ文字列。 | アイテムの設定 |
components | セクション | {} | モダンアイテムコンポーネント設定(Minecraft 1.20.5+)。 | アイテムの設定 |
sound | Sound名 | なし | クリックが受理された際に再生される効果音。 | メニュー・メッセージ・サウンド |
close-menu | 真偽値 | true | アクション完了後にメニュー画面を閉じるかどうか。 | メニュー・メッセージ・サウンド |
click-policy | 列挙型 | PRIMARY | 反応するクリック種類(PRIMARY, LEFT, RIGHT, ANY)。 | アクション概要 |
command | 文字列 | なし | 簡易アクション記法(プレイヤーコマンド、sub_<id>, main_mainopen)。 | コマンドを実行する |
action | セクション | なし | 単一の型付きアクション定義。 | アクション概要 |
actions | リスト | なし | 順番に実行される複数アクションの定義リスト。 | アクション概要 |
visible-when | 条件 | 常に許可 | 条件が false の場合、要素自体をメニューに表示しません。 | 表示・使用条件 |
enabled-when | 条件 | 常に許可 | 条件が false の場合、表示されますがクリックを拒否します。 | 表示・使用条件 |
disabled-message | 文字列 | 言語ファイル | enabled-when で拒否された際にプレイヤーへ送信されるメッセージ。 | 表示・使用条件 |
cooldown | 時間/セクション | なし | アイテムクリックの再使用待機時間制限。 | クールダウン |
variants | リスト | [] | プレイヤーの権限や条件に応じて見た目や動作を差し替えるバリアント定義。 | バリアント |
input-refs | 文字列リスト | [] | アクション実行前に収集する inputs のIDリスト。 | 入力 |
3. 表示設定 (presentation)
メニュー全体の描画方式を制御する presentation: セクションの設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
mode | 列挙型 | inventory | 表示モード(inventory, native-preferred, native-required, rich-preferred, rich-required, auto)。 | Body・Presentation |
fallback | 真偽値 | true | 要求した表示モードが非対応の場合にインベントリGUIへフォールバックするか。 | Body・Presentation |
inventory.size | 数値 | 54 | インベントリGUI時のスロット数。 | インベントリGUI |
inventory.background | Material名 | GRAY_STAINED_GLASS_PANE | インベントリGUI時の背景アイテム素材。 | インベントリGUI |
native.columns | 数値 | 2 | Native Dialog時のボタン列数(1〜3)。 | Native Dialog |
native.button-width | 数値 | 150 | Native Dialog時のボタン横幅。 | Native Dialog |
native.can-close-with-escape | 真偽値 | true | ESCキーでダイアログを閉じられるようにするか。 | Native Dialog |
native.pause | 真偽値 | false | シングルプレイ時にゲームを一時停止するか。 | Native Dialog |
4. アクション設定 (action / actions)
クリック時に実行する11種類の型付きアクションのプロパティです。
アクション種別 (type) | 主な設定キー | 説明 | 詳細解説ページ |
|---|---|---|---|
command | command, executor | player または console としてコマンドを実行。 | コマンドを実行する |
player-command | command | クリックしたプレイヤー自身としてコマンドを実行。 | コマンドを実行する |
console-command | command | サーバーコンソール(最高権限)としてコマンドを実行。 | コマンドを実行する |
open-menu | menu | 指定したメニューIDを開く(描画完了まで待機)。 | メニュー・メッセージ・サウンド |
close-menu | なし | 操作元のメニュー画面を閉じる。 | メニュー・メッセージ・サウンド |
message | message | プレイヤーにチャットメッセージを送信。 | メニュー・メッセージ・サウンド |
sound | sound, volume, pitch | プレイヤーに効果音を再生。 | メニュー・メッセージ・サウンド |
title | title, subtitle, fade-in, stay, fade-out | 画面中央にタイトル・サブタイトルを表示。 | メニュー・メッセージ・サウンド |
teleport | world, x, y, z, yaw, pitch, safe, reset-velocity, no-fall-ticks | プレイヤーを指定ワールド・座標へテレポート。 | 高度なアクション |
delay | duration | 指定時間(例: 3s, 500ms)だけ後続アクションを非同期待機。 | 高度なアクション |
potion-effect | effect, duration, amplifier, ambient, particles | プレイヤーにステータス効果(ポーション効果)を付与。 | 高度なアクション |
input | prompt, input-type, min, max, timeout-seconds, command, actions | チャットで入力を受け付けてから処理を継続。 | 高度なアクション |
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
6. 入力フォーム設定 (inputs)
メニュー全体の inputs: リストで宣言するフォーム入力フィールドの設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
id | 文字列 | 必須 | 入力フィールドの識別ID({input.<id>} で参照)。 | 入力 |
type | 列挙型 | 必須 | 入力タイプ(text, integer, decimal, boolean, option)。 | 入力 |
label | 文字列 | なし | プレイヤーに提示する入力ラベル(プロンプト文言)。 | 入力 |
min | 数値 | なし | integer / decimal の最小値。 | 入力 |
max | 数値 | なし | integer / decimal の最大値。 | 入力 |
max-length | 数値 | 128 | text 入力の最大文字数制限。 | 入力 |
initial | 各種型 | なし | フィールドの初期値(入力条件を満たしている必要があります)。 | 入力 |
options | リスト | [] | option 選択肢の定義リスト(id と display を含む)。 | 入力 |
timeout-seconds | 数値 | config既定 | 入力待ちのタイムアウト秒数。 | 入力 |
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 等)。 | クールダウン |
bypass-permission | 文字列 | なし | クールダウンを免除するバイパスパーミッションノード。 | クールダウン |
message | 文字列 | 言語ファイル | クールダウン中にクリックした際のメッセージ({remaining} 展開対応)。 | クールダウン |
key | 文字列 | なし | 複数アイテムでクールダウンを共有するためのグループ識別子。 | クールダウン |
9. バリアント設定 (variants)
条件に応じてアイテムを動的に差し替える variants: リストの設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
id | 文字列 | 必須 | バリアントの識別ID。 | バリアント |
when | 条件 | 必須 | このバリアントを適用するための成立条件。 | バリアント |
override | セクション | 必須 | 成立時に上書きするアイテム設定(name, lore, material, command 等)。 | バリアント |
10. 動的オープンコマンド設定 (open-command)
メニュー専用のサーバーコマンドを登録する open-command: セクションの設定です。
| 設定キー | 型 | 初期値 | 説明 | 詳細解説ページ |
|---|---|---|---|---|
name | 文字列 | 必須 | 登録するメインコマンド名(例: shop)。 | メニューを開く |
aliases | 文字列リスト | [] | コマンドの別名(エイリアス)リスト。 | メニューを開く |
permission | 文字列 | なし | コマンド実行に必要なパーミッションノード。 | メニューを開く |
permission-default | 真偽値/文字列 | op | 既定許可対象。true で全員に許可、false/op でOPのみに許可。 | メニューを開く |