YAML Editor

Unity Asset版はローカルExcel入力と、header.input_path にGoogle Sheets URLを指定する入力の両方に対応しています。

概要

WienerのYAMLファイルをUnityEditorから編集するためのEditorWindowです。

起動

メニューバーから Tools > Wiener > Open Yaml Editor で起動します。

画面

ウィンドウ構成

ツールバー

Root フォルダ

YAMLのルートディレクトリを指定します。

デフォルト：Assets/Wiener/Data/client/yaml

... ボタンでフォルダダイアログを開いて変更できます。

Google Sheets Credential JSON

Googleスプレッドシートを読み込む場合に使用する、サービスアカウントの認証JSONファイルを指定します。

認証JSONファイルの生成手順は Google Sheets入力の設定手順 を参照してください。

... ボタンでJSONファイルを選択できます。

指定済みの場合は Clear ボタンで設定を解除できます。

YAMLツリー

左ペインのツリーにYAMLファイルがフォルダ単位で表示されます。

• ファイルの選択：クリックで選択し、右ペインで編集できます
• 検索：ツリー上部の検索フィールドに文字を入力すると、一致するYAMLファイルだけを表示します。表示時は一致ファイルまでの親フォルダを残すため、絞り込み後もフォルダ構造を確認できます
• 複数選択：Ctrl + クリック で個別追加/解除、Shift + クリック で範囲選択できます。複数選択時の Duplicate / Delete は選択中のファイル・フォルダすべてに適用されます
• 空白部分の右クリック：ツリー末尾より下の空白を右クリックすると、ルートフォルダに対するメニューを表示します
• 作成・リネーム後の選択：フォルダ作成、YAML作成、リネーム、複製の完了後は対象の項目が選択状態になります
• 自動再構築：ウィンドウがフォーカスを得た時に自動でツリーを再構築します。Unity外部でのファイル・フォルダの追加・削除・変更が即座に反映されます

右クリックメニュー

Create From Input

ExcelファイルまたはGoogleスプレッドシートを読み込み、指定したシートのヘッダー行をもとにYAMLを1ファイル生成します。

Key Style で UpperCamel を選択した場合は、生成される fields[].key だけでなく header.name もUpperCamelになります。

Type RowでEnumを指定する

Type Row のセルには、通常の型名に加えて、YAMLルート内にあるEnum形式YAMLのファイル名（拡張子なし）または header.name を指定できます。対象になるのは header.source_type が Enum のYAMLだけです。指定名の大文字小文字は区別しません。

たとえば enum/item_type.yaml の header.name が ItemType の場合、型として item_type または ItemType を指定すると、次のフィールドを生成します。

- key: ItemType
  name: item_type
  type: Foreignkey
  relation:
    yaml: enum/item_type.yaml
    from: From
    to: To

from と to には、参照先Enum形式YAMLに実際に定義されている From / from、To / to のキー名を使用します。指定したEnumが見つからない場合は type: String として生成します。

Create From Enum

Enum専用のExcelファイル（EnumBase.xlsx など）またはGoogleスプレッドシートを読み込み、全シートからEnum形式のYAMLを一括生成します。

動作仕様

• 全シートが対象。シート選択は不要です。
• シート名が EnumRule のシートは存在していても除外されます。EnumRule シートは必須ではありません。
• 各シートの A1セル をenum名およびファイル名のベースとして使用します。A1セルが空の場合はシート名を使用します。
• 対象フォルダ内に 同名のYAMLが既に存在する場合はそのシートをスキップします（上書きしません）。
• ヘッダー行（to / from / value 列）を自動検出します。見つからない場合は5行目をデフォルトとします。
• value 列の値がすべて整数の場合は type: Int、それ以外は type: String として出力します。

入力項目

最後に成功したSource、ExcelファイルパスまたはスプレッドシートURL、Key Styleは保存され、次回ダイアログを開いた時に復元されます。Targetフォルダは保存されず、常に右クリックしたフォルダまたはファイルの親フォルダが対象になります。

Recreate From Enum

前回成功した Create From Enum のSource、ExcelファイルパスまたはスプレッドシートURL、Key Styleを使って、右クリックしたフォルダにEnum形式YAMLを再生成します。

Unity Asset版はローカルExcelとGoogleスプレッドシートの両方に対応しており、GoogleスプレッドシートからのRecreate From Enumも使用できます。

出力YAMLの構造

Key Style を UpperCamel に設定し、A1セルに gender_type と記載されたシートがある場合、以下のYAMLが生成されます（ファイル名: gender_type.yaml）。A1セルが空の場合は、シート名がファイル名と header.name の元になります。

header:
  input_path:
  - path: EnumBase.xlsx
  sheet: 性別
  row: 5
  base_type: Normal
  source_type: Enum
  name: GenderType
  output_path: Enum
fields:
- key: To
  name: to
  type: Enum
  enum: GenderType
  enum_value: Value
  enum_comment: From
- key: From
  name: from
  type: String
- key: Value
  name: value
  type: Int
...

ヘッダーエディタ

YAMLの header: 項目を編集できます。

詳細はHeader定義を参照してください。

フィールドエディタ

YAMLの fields: 項目を編集できます。

フィールド一覧操作

フィールドパラメータ

Relation（Foreignkey時）

type が Foreignkey の場合に表示されます。

Enum（Enum時）

type が Enum の場合に表示されます。

Validate

各フィールドのバリデーション設定です。

詳細はFields定義を参照してください。

Multi YAML Actionエディタ

base_type: MultiYamlAction の場合にフィールドエディタの代わりに表示されます。

各アイテムで参照するYAMLと対象keyを設定します。

プレビューペイン

編集中のYAMLをテキスト形式でリアルタイムプレビューします。テキストは選択してコピー可能です。

ツールバーボタン

ショートカット