drinkingtea/nostalgia
drinkingtea/nostalgia
2
0
Fork 0
Code Issues 6 Pull Requests Actions Releases 6 Activity

[nostalgia] Update developer-handbook

Browse Source
This commit is contained in:
Gary Talent 2023-12-23 19:08:18 -06:00
parent 45ec39f77b
commit 050339ba09
1 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
developer-handbook.md
View File

@ -20,14 +20,6 @@ All components have a platform indicator next to them:
(-G) - GBA (-G) - GBA
(P-) - PC (P-) - PC
* GlUtils - OpenGL helpers (P-)
* Keel - asset management system (PG)
* Turbine - platform abstraction and user I/O (PG)
* gba - GBA implementation (PG)
* glfw - GLFW implementation (P-)
* Studio - where most of the studio code lives as library (P-)
* applib - used for per project studio executables
* modlib - used for studio modules to interact with studio
* Nostalgia * Nostalgia
* modules * modules
* core - graphics system for Nostalgia (PG) * core - graphics system for Nostalgia (PG)
@ -42,6 +34,15 @@ All components have a platform indicator next to them:
* studio - makes the games (P-) * studio - makes the games (P-)
* tools - command line tools (P-) * tools - command line tools (P-)
* pack - packs a studio project directory into an OxFS file (P-) * pack - packs a studio project directory into an OxFS file (P-)
* Olympic
* Applib - Library for creating apps as libraries that injects Keel and Studio modules
* Keel - asset management system (PG)
* Studio - where most of the studio code lives as library (P-)
* applib - used for per project studio executables
* modlib - used for studio modules to interact with studio
* Turbine - platform abstraction and user I/O (PG)
* gba - GBA implementation (PG)
* glfw - GLFW implementation (P-)
* deps - project dependencies * deps - project dependencies
* Ox - Library of things useful for portable bare metal and userland code. Not really that external... * Ox - Library of things useful for portable bare metal and userland code. Not really that external...
* clargs - Command Line Args processing (PG) * clargs - Command Line Args processing (PG)
@ -54,9 +55,19 @@ All components have a platform indicator next to them:
* model - Data structure modelling (PG) * model - Data structure modelling (PG)
* preloader - library for handling preloading of data (PG) * preloader - library for handling preloading of data (PG)
* std - Standard-ish Library with a lot missing and some things added (PG) * std - Standard-ish Library with a lot missing and some things added (PG)
* GlUtils - OpenGL helpers (P-)
* teagba - GBA assembly startup code (mostly pulled from devkitPro under MPL * teagba - GBA assembly startup code (mostly pulled from devkitPro under MPL
2.0), and custom GBA hardware interop code (-G) 2.0), and custom GBA hardware interop code (-G)
## Platform Notes
### GBA
#### Graphics
* Background Palette: 256 colors
* Sprite Palette: 256 colors
## Code Base Conventions ## Code Base Conventions
### Formatting ### Formatting