diff --git a/.idea/dictionaries/project.xml b/.idea/dictionaries/project.xml new file mode 100644 index 0000000..cefc59e --- /dev/null +++ b/.idea/dictionaries/project.xml @@ -0,0 +1,7 @@ + + + + uaid + + + \ No newline at end of file diff --git a/README.md b/README.md index b18b935..5dcbcc7 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,44 @@ +## Project Layout + +'uaid': + Unique asset ID: example: 12345678901234567890123456789012 + it's 32 chars long and is unique for every loaded asset. + + +```yaml + +# MyGame.onx +project: + name: MyGame + version: 1.0.0 + description: A top-down RPG made in the Onyx Engine + author: + +assets: + - type: texture + uaid: + path: res://assets/textures/player.png + uid: player_texture + - type: audio + uaid: + path: res://assets/sounds/theme.ogg + uid: theme_music + +scenes: + - id: main_menu + uaid: + file: res://scenes/main_menu.yaml + - id: level1 + uaid: + file: res://scenes/level1.yaml + +settings: + resolution: [1920, 1080] + fullscreen: false + vsync: true + language: en-US + +``` \ No newline at end of file