Files
GameLauncher/AGENTS.md
T
armonica 8f67ab1864 docs: UI文字列の日本語統一および変更時チェックリストを更新
- UI文字列追加・変更時の日本語表記遵守規則を明記
- 変更時チェックリストに日本語出力確認項目を追加
2026-10-14 09:57:11 +09:00

68 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# AGENTS.md — GameLauncher エージェント規則
このファイルは **GameLauncher プロジェクトの AI エージェント向け規則** である。
本プロジェクトでのすべての変更(コード追加・修正・削除・発行)は、必ず以下の規則に従って実施すること。
> 注意: 本規則は今後も追加・変更され得る。作業を開始する前に必ず本ファイルを確認し、
> 最新の規則に従うこと。
---
## 1. フォルダ構成の原則(エンジン別集約)
- エンジン別の処理は `Engines/<Engine>/` に集約する。
- 例: `Engines/Rgss/`, `Engines/Tkool/`, `Engines/Tyrano/`, `Engines/Wolf/`, `Engines/Unity/`, `Engines/Nwjs/`
- エンジン共通の基盤は `Engines/Common/`(例: `IEngineModule.cs`, `EngineDetectionHelper.cs`)。
- エンジン別クラスの名前空間は `GameLauncher.Engines.<Engine>` とする。
- 例: `GameLauncher.Engines.Rgss`, `GameLauncher.Engines.Wolf`
- エンジンに依存しない共通処理のみ `Services/` / `Models/` / `Helpers/` に置く。
- 例: `Services/GameScannerService.cs`, `Models/GameItemBase.cs`, `Helpers/AppPathHelper.cs`
## 2. ゲーム個別対応の規則(他ゲームへ影響させない)
- 特定ゲーム専用の処理は `Engines/<Engine>/Games/<GameName>/` に作成する。
- 名前空間は `GameLauncher.Engines.<Engine>.Games.<GameName>` とする。
- 例: `Engines/Rgss/Games/IiniTitleRepair/GameIniTitleRepair.cs`
→ `namespace GameLauncher.Engines.Rgss.Games.IiniTitleRepair`
- ゲーム個別処理は共通処理から **明示的に呼び出す** こと(暗黙のグローバル副作用を持たせない)。
- **特定ゲーム専用の改造が他ゲームへ影響を与えてはならない(必須要件)。**
- 可能な限りバックアップからの復元手段を用意し、後で元に戻せるようにする。
- プラグインで対応できない場合は、バックアップ・復元可能な直接ファイル変更を許容する。
## 3. 外部ツール・外部ファイルの規則(エンジン単位で参照)
- エンジン専用の外部ツール/ファイルは `Engines/<Engine>/Tools/` に配置する。
- 例: `Engines/Rgss/Tools/SRPG_Unpacker.exe`, `Engines/Wolf/Tools/UberWolfCli.exe`
- パス解決には共通ヘルパーを使用する。
- `AppPathHelper.ResolveEngineTool(string engineName, string toolFileName)`
- `AppPathHelper.GetEngineToolsDirectory(string engineName)`
- **エンジン間でツールを共有しない。旧 `Tools/` 直下を参照するコードを新規に書かない。**
- 外部ツールの配置は `publish.ps1` が `Engines/<Engine>/Tools/` を再帰的に発行先へコピーする。
## 4. ビルド・発行の規則
- 変更後は **必ずビルドを成功させる**(`build_solution` を使用)。
- 発行は `publish.ps1` で行い、`Z:\自作ソフト\GameLauncher` へ配置して起動確認まで行う。
- 単一ファイル発行(`PublishSingleFile`)の設定を維持する。
## 5. コメント・表記の規則
- コードコメントは既存コードに合わせて日本語/英語を適切に使い分ける。
- 新規ファイルには冒頭に説明コメントを付ける。
- ファイル名・シンボル参照はバッククォートで囲む。
- UI 文字列を追加・変更する場合は、既存の日本語表記に合わせる。
> 注: ユーザーから見える出力の言語(日本語)については、グローバルのユーザー記憶
> (`/memories/preferences.md`)で規定する。重複を避けるため本ファイルでは規定しない。
---
## 6. 変更時のチェックリスト
1. 本ファイル(`AGENTS.md`)の最新規則を確認したか。
2. エンジン別の処理は `Engines/<Engine>/` 配下に置いたか。
3. ゲーム個別処理は `Engines/<Engine>/Games/<GameName>/` に分離し、他ゲームへ影響しないか。
4. 外部ツールは `Engines/<Engine>/Tools/` にあり、`AppPathHelper` 経由で参照しているか。
5. ビルドが成功し、`publish.ps1` で発行できるか。
6. ユーザーから見える出力が日本語になっているか(判定基準は `/memories/preferences.md`)。