nixie-fx-authoring

NixieFX のオーサリング

生成されたデフォルト値を使ってプロジェクトデータを作成し、変更のたびに検証して、実際のエディターで見た目を確認します。

ワークフロー

1. ユーザー専用フォルダー内で、対象の vfx-editor.prj を見つけます。無関係なプロジェクトは検索も変更もしないでください。

2. project-format.md を読みます。プロジェクトが存在しない場合は、同梱テンプレートからマニフェストを初期化し、印の付いた値をすべて置き換えます。

3. 編集する前に、インストール済み CLI の仕様を確認します。

   npx nixie-fx --help
   

   公開されているコマンドやオプションが異なる場合は、同梱のヘルプに従ってください。パッケージが利用できない場合は、代替の形式をでっち上げず、公開リリースが不完全であることを報告します。

4. effect-workflow.md を読み、CLI で正規化されたエフェクトを作成します。

   npx nixie-fx effect create --project . --name "Fire Burst" --profile pixi-ui-2d
   

5. スキーマ全体を手書きするのではなく、生成されたエフェクトを編集します。無関係なエミッターとプロジェクトファイルは保持してください。

6. 参照されるファイルを設定済みのアセットルートに追加し、エフェクト内の参照はスラッシュ区切りのプロジェクト相対パスにします。

7. 意味のある変更を加えるたびに検証します。

   npx nixie-fx validate .
   

8. すべてのエラーとブロッカーを解消します。一部サポートの警告は、対象のバックエンドを踏まえて確認します。

9. validation-and-export.md を読み、エクスポートします。

   npx nixie-fx export .
   npx nixie-fx export-status .
   

10. Chromium 対応ブラウザーで nixiefx.com/editor を開き、Open Folder を選択して、vfx-editor.prj が含まれるフォルダーを指定します。対象バックエンドのプレビューを確認し、エフェクトを調整します。スキーマ検証は、見た目の承認を意味するものではありません。

オーサリングのルール

• vfx-editor.prj とソースエフェクトはオーサリングデータとして扱い、out/vfx はゲーム向けの生成データとして扱います。
• エフェクトを修正するために、生成された out/vfx ファイルを編集しないでください。ソースを変更して、再度エクスポートします。
• プロジェクト、エフェクト、エミッターには一意の ID を生成します。ファイルをコピーしただけで ID を再利用しないでください。
• パスは設定済みのルート内に収めます。ユーザーから明示的な要望がない限り、外部への出力を有効にしないでください。
• pixi-ui-2d、three-world-3d、または portable を意図して使い分けます。Portable は共通でサポートされる範囲を意味し、自動的な互換性を保証するものではありません。
• 実行時用に準備されたメッシュアセットを使います。未加工のソース形式は実行時の入力には使えません。
• 差分を限定し、ユーザーが作成したアセット、マテリアル、設定、出力ポリシーを保持します。

同梱テンプレート

プロジェクトのマニフェストが存在しない場合に限り、vfx-editor.prj.template.json を使います。これを vfx-editor.prj としてコピーし、すべての REPLACE-* 文字列を置き換えてから、effect create を実行する前に設定済みのフォルダーを作成します。

完了時の確認

• vfx-editor.prj が有効で、設定済みのすべてのパスを安全に解決できます。
• ソースエフェクトにエラーやブロッカーがなく、検証に合格しています。
• 対象バックエンドに、説明のつかないブロックまたは一部サポートの動作がありません。
• エクスポートにより、有効なマニフェスト、エフェクトファイル、参照されるアセットが再生成されます。
• 変更されたのは、意図したソースファイルと生成ファイルのみです。
• 実際のエディターでエフェクトの見た目を確認しています。確認していない場合は、見た目の確認が未完了であると報告します。