Architecture Reference Documentation: Or How To Use PPB

[pathunstrom]

Goal of this document is going to be addressing all the moving pieces of ppb, all of their relationships, in a prose style.

At the moment, this is just outlines and some thoughts on critical warnings or instructions to include. Open to all feedback.

[AstraLuma]

reminder that using dataclasses isn't a requirement. it's just an easy way to make a data bag.

[pathunstrom]

That's as much a suggestion/how we do it as anything. But will keep in mind.

[mxashlynn]

This section is really well written -- I love it!
Only suggestion I have is to perhaps put a list of all the major topics to be covered right up front, something like:

• GameObject
• GameEngine
• Systems
• Scenes
• Events
• Assets

[mxashlynn]

I might suggest including something like:
"Games developed using PPB are generally made of Sprites organized into a hierarchy of Scenes. These Sprites behave according to rules laid out in Systems, and communicate via Events. Sprites load Assets from storage. A special GameObject manages Time and another handles the virtual Camera."

[mxashlynn]

In thinking about it, a paragraph like this might mean the list I suggested above is not needed.

[mxashlynn]

I really like that this "reasoning for uncommon names" is included.
Doesn't need to be long, but this is the sort of "getting inside the library maintainer's head" thing I find super valuable!