added design doc and README

2026-09-09 14:21:31 +01:00
parent e069c6f159
commit c77a0d16d1
2 changed files with 2954 additions and 0 deletions
@@ -0,0 +1,38 @@
+# SpeedBleed
+
+**A high-stakes first-person combat racing game inspired by the aggressive arcade racing and vehicular combat games of the PS1 era.**
+
+# Directory Structure
+
+**Heres where your files should go:**
+
+.gitignore - only edit this if any temp files are leaking into the repo
+.gitattributes - leave this as is
+
+├── docs
+│   └── designdoc.md - use this as reference for the full project scope, requirements, etc.
+├── project
+│   ├── assets - General game assets
+│   │   ├── audio
+│   │   ├── fonts
+│   │   ├── models
+│   │   └── textures
+│   ├── scenes - Assets that only appear on certain levels (cars, guns, tracks etc)
+│   │   ├── cockpit
+│   │   ├── tracks
+│   │   ├── ui
+│   │   ├── vehicles
+│   │   └── weapons
+│   ├── scripts - Game logic code
+│   │   ├── cockpit
+│   │   ├── core
+│   │   ├── ui
+│   │   ├── vehicle
+│   │   └── weapons
+│   └── shaders - The PS1 shaders
+├── rawAssets - Uncompiled and uncompressed assets (none of this should be in final release!)
+│   ├── art
+│   └── audio
+└── README.md - this
+
+*NOTE: The folder in the directory structure may not exist. If it doesn't, create it!*