Adds initial project setup and README
Adds a basic README file with project information, features, and a project layout example. Adds a dictionary configuration file to specify project-specific words.
This commit is contained in:
parent
626e8b2b71
commit
19d1b9df55
7
.idea/dictionaries/project.xml
generated
Normal file
7
.idea/dictionaries/project.xml
generated
Normal file
@ -0,0 +1,7 @@
|
||||
<component name="ProjectDictionaryState">
|
||||
<dictionary name="project">
|
||||
<words>
|
||||
<w>uaid</w>
|
||||
</words>
|
||||
</dictionary>
|
||||
</component>
|
41
README.md
41
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: <Author name>
|
||||
|
||||
assets:
|
||||
- type: texture
|
||||
uaid: <len 32 int>
|
||||
path: res://assets/textures/player.png
|
||||
uid: player_texture
|
||||
- type: audio
|
||||
uaid: <len 32 int>
|
||||
path: res://assets/sounds/theme.ogg
|
||||
uid: theme_music
|
||||
|
||||
scenes:
|
||||
- id: main_menu
|
||||
uaid: <len 32 int>
|
||||
file: res://scenes/main_menu.yaml
|
||||
- id: level1
|
||||
uaid: <len 32 int>
|
||||
file: res://scenes/level1.yaml
|
||||
|
||||
settings:
|
||||
resolution: [1920, 1080]
|
||||
fullscreen: false
|
||||
vsync: true
|
||||
language: en-US
|
||||
|
||||
```
|
Loading…
Reference in New Issue
Block a user