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

[nostalgia] Update developer handbook

Browse Source
This commit is contained in:
Gary Talent
2022-02-10 02:05:11 -06:00
parent a64aa8b586
commit f4895948e2
1 changed files with 1 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
developer-handbook.md
View File

@@ -24,7 +24,6 @@ All components have a platform indicator next to them:
* core - platform abstraction and user I/O (PG) * core - platform abstraction and user I/O (PG)
* gba - GBA implementation (-G) * gba - GBA implementation (-G)
* glfw - GLFW implementation (P-) * glfw - GLFW implementation (P-)
* qt - Qt implementation, mostly for studio support (P-)
* userland - common things needed by all non-bare-metal implementations (P-) * userland - common things needed by all non-bare-metal implementations (P-)
* studio - studio plugin for core (P-) * studio - studio plugin for core (P-)
* player - plays the games (PG) * player - plays the games (PG)
@@ -35,7 +34,7 @@ All components have a platform indicator next to them:
* studio - studio plugin for world (P-) * studio - studio plugin for world (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 (P-) * clargs - Command Line Args processing (PG)
* claw - Reads and writes Metal or Organic Claw with header to indicate which * claw - Reads and writes Metal or Organic Claw with header to indicate which
* fs - file system (PG) * fs - file system (PG)
* mc - Metal Claw serialization, builds on model (PG) * mc - Metal Claw serialization, builds on model (PG)
@@ -367,14 +366,12 @@ Here is an example from the Nostalgia/Core package:
```cpp ```cpp
struct NostalgiaPalette { struct NostalgiaPalette {
static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaPalette"; static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaPalette";
static constexpr auto Fields = 1;
static constexpr auto TypeVersion = 1; static constexpr auto TypeVersion = 1;
ox::Vector<Color16> colors; ox::Vector<Color16> colors;
}; };
struct NostalgiaGraphic { struct NostalgiaGraphic {
static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaGraphic"; static constexpr auto TypeName = "net.drinkingtea.nostalgia.core.NostalgiaGraphic";
static constexpr auto Fields = 6;
static constexpr auto TypeVersion = 1; static constexpr auto TypeVersion = 1;
int8_t bpp = 0; int8_t bpp = 0;
// rows and columns are really only used by TileSheetEditor // rows and columns are really only used by TileSheetEditor
@@ -420,11 +417,9 @@ class FileAddress {
public: public:
static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress"; static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress";
static constexpr auto Fields = 2;
union Data { union Data {
static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress.Data"; static constexpr auto TypeName = "net.drinkingtea.ox.FileAddress.Data";
static constexpr auto Fields = 3;
char *path; char *path;
const char *constPath; const char *constPath;
uint64_t inode; uint64_t inode;