chore: 资源组织规范

This commit is contained in:
2026-03-27 22:25:15 +08:00
parent 209a795141
commit 0ec85e0cda
2 changed files with 167 additions and 6 deletions
+9 -6
View File
@@ -1,4 +1,4 @@
# CLAUDE.md
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
@@ -21,7 +21,7 @@ The project uses a custom modular framework with these key systems:
- **EventSystemKit**: Decoupled event system for inter-system communication
- **PoolKit**: Object pooling for performance optimization
- **ResourceKit**: Asset loading and resource management
- **Note**: New code should use `ResourceSystem` (via Addressables), see [Resource Loading Best Practices Guide](Docs/ResourceLoadingBestPractices.md) for details
- **Note**: New code should use `ResourceSystem` (via Addressables), see [Resource Loading Best Practices Guide](Docs/ResourceLoadingBestPractices.md) for details. **Where assets live on disk** (e.g. `GameContent/`, `Narrative/`) is defined in [Resource Management Spec](Docs/ResourceManagementSpec.md).
- **SingletonKit**: Singleton base classes for managers
- **StateMachineKit**: Game state management
- **TimelineKit**: Timeline-based event sequencing
@@ -97,9 +97,11 @@ Assets\Open C# Project.regenerate-sln.bat
### Yarn Dialogue Files
Located in `Assets/Resources/Yarn/`, organized by character and day:
- Each character has their own folder
- Files follow pattern: `{Character}_{Stage}.yarn`
Target layout and co-location with Dialog localization tables: [Resource Management Spec](Docs/ResourceManagementSpec.md) (`Assets/Narrative/Yarn/`, `Assets/Narrative/Localization/`). Legacy paths may still include `Assets/Resources/Yarn/` during migration.
Convention for file naming and UTF-8:
- Organize by narrative module / character and day as the project requires
- Files often follow pattern: `{Character}_{Stage}.yarn`
- Use UTF-8 encoding for Chinese text support
### Asset Naming Conventions
@@ -182,7 +184,8 @@ For testing mechanics before Unity implementation:
## Reference Documents
- [Resource Loading Best Practices Guide](Docs/ResourceLoadingBestPractices.md) - Addressables resource loading specifications, naming conventions, and performance optimization
- [Resource Loading Best Practices Guide](Docs/ResourceLoadingBestPractices.md) - How to load assets: `ResourceSystem`, Addressables Key/Group/Label, lifecycle and performance
- [Resource Management Spec](Docs/ResourceManagementSpec.md) - Where to place assets: `GameContent/`, `Narrative/` (Yarn + Dialog tables), `_Archive/`, and exceptions (distinct from loading mechanics above)
- [Commit Convention](COMMIT_CONVENTION.md) - Git commit message format and branch naming rules
---