From 19d1b9df55071b31163bad1ccd57015213c17c1c Mon Sep 17 00:00:00 2001
From: OusmBlueNinja <89956790+OusmBlueNinja@users.noreply.github.com>
Date: Mon, 2 Jun 2025 13:15:09 -0500
Subject: [PATCH] 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.
---
 .idea/dictionaries/project.xml |  7 ++++++
 README.md                      | 41 ++++++++++++++++++++++++++++++++++
 2 files changed, 48 insertions(+)
 create mode 100644 .idea/dictionaries/project.xml

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 @@
+<component name="ProjectDictionaryState">
+  <dictionary name="project">
+    <words>
+      <w>uaid</w>
+    </words>
+  </dictionary>
+</component>
\ 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: <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
+
+```
\ No newline at end of file