include info about asset sources file
This commit is contained in:
36
docs/MAP.md
36
docs/MAP.md
@@ -165,13 +165,46 @@ audio/
|
||||
### Visual Assets (`assets/`)
|
||||
```
|
||||
assets/
|
||||
├── audio/
|
||||
│ ├── music/ # Background music files
|
||||
│ └── sfx/ # Sound effects
|
||||
├── sprites/
|
||||
│ ├── characters/skeleton/ # Character artwork
|
||||
│ ├── gems/ # Match-3 gem sprites
|
||||
│ └── ui/ # User interface elements
|
||||
├── textures/
|
||||
│ └── backgrounds/ # Background images
|
||||
└── fonts/ # Custom fonts
|
||||
├── fonts/ # Custom fonts
|
||||
└── sources.yaml # Asset metadata and attribution
|
||||
```
|
||||
|
||||
### Asset Management (`assets/sources.yaml`)
|
||||
**REQUIRED**: Every asset added to the project must be documented in `assets/sources.yaml` with:
|
||||
- **Source information** - Where the asset came from (URL, artist, store, etc.)
|
||||
- **License details** - Usage rights, attribution requirements, commercial permissions
|
||||
- **Attribution text** - Exact text to use for credits if required
|
||||
- **Modification notes** - Any changes made to the original asset
|
||||
- **Usage context** - Where and how the asset is used in the project
|
||||
|
||||
**Example format:**
|
||||
```yaml
|
||||
audio:
|
||||
music:
|
||||
"Space Horror InGame Music (Exploration) _Clement Panchout.wav":
|
||||
source: "https://freesound.org/people/ClementPanchout/"
|
||||
license: "CC BY 4.0"
|
||||
attribution: "Space Horror InGame Music by Clement Panchout"
|
||||
modifications: "Converted to WAV, loop points adjusted"
|
||||
usage: "Background music for all gameplay scenes"
|
||||
|
||||
sprites:
|
||||
gems:
|
||||
"gem_blue.png":
|
||||
source: "Created in-house"
|
||||
license: "Project proprietary"
|
||||
attribution: "Skelly development team"
|
||||
modifications: "None"
|
||||
usage: "Match-3 blue gem sprite"
|
||||
```
|
||||
|
||||
## Data & Configuration
|
||||
@@ -229,6 +262,7 @@ Game --> scenes/game/gameplays/match3_gameplay.tscn, clickomania_gameplay.tscn
|
||||
AudioManager --> assets/audio/music/
|
||||
SettingsManager --> localization/languages.json
|
||||
AudioManager --> data/default_bus_layout.tres
|
||||
Asset Management --> assets/sources.yaml (required for all assets)
|
||||
```
|
||||
|
||||
## Logging System
|
||||
|
||||
Reference in New Issue
Block a user