Compare commits

..

2 Commits

Author SHA1 Message Date
e4ae23e114 [olympic/developer-handbook] Remove Ox submodules from project structure
All checks were successful
Build / build (push) Successful in 2m31s
2024-10-04 01:22:21 -05:00
67187d5ec5 [olympic/developer-handbook] Elaborate more on exception usage 2024-10-04 01:18:25 -05:00

View File

@ -44,17 +44,8 @@ All components have a platform indicator next to them:
* gba - GBA implementation (PG) * gba - GBA implementation (PG)
* glfw - GLFW implementation (P-) * 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.
* clargs - Command Line Args processing (PG) Not really that external... (PG)
* claw - Reads and writes Metal or Organic Claw with header to indicate which
* event - Qt-like signal system (PG)
* fs - file system (PG)
* logconn - connects logging to Bullock (P-)
* mc - Metal Claw serialization, builds on model (PG)
* oc - Organic Claw serialization (wrapper around JsonCpp), builds on model (P-)
* model - Data structure modelling (PG)
* preloader - library for handling preloading of data (PG)
* std - Standard-ish Library with a lot missing and some things added (PG)
* GlUtils - OpenGL helpers (P-) * 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)
@ -177,6 +168,9 @@ Instead of throwing exceptions, all engine code should return
For the sake of consistency, try to stick to ```ox::Error``` in non-engine code For the sake of consistency, try to stick to ```ox::Error``` in non-engine code
as well, but non-engine code is free to use exceptions when they make sense. as well, but non-engine code is free to use exceptions when they make sense.
Exceptions should generally just use ```OxException```, which is bascially an
exception form of ```ox::Error```.
### File I/O ### File I/O
All engine file I/O should go through Keel, which should go through All engine file I/O should go through Keel, which should go through