giant freakin documentation and reorganization pass, it also uses cmake because all the building was getting too complicated for shell scripts

This commit is contained in:
2025-09-29 20:31:42 -07:00
parent a5f837189b
commit 0edb4b50d2
71 changed files with 4895 additions and 127 deletions

View File

@@ -0,0 +1,3 @@
\namespace actions
\brief Defines game logic functions for in-game actions.

2
res/doc/python/core.md Normal file
View File

@@ -0,0 +1,2 @@
\namespace core
\brief Bare minimum needed for a Seagull-game-like environment.

View File

@@ -0,0 +1,5 @@
\namespace desktop
\brief Implementation code for desktop specific needs.
This module also includes a rudimentary "local storage" system within JS_API, since pywebview's local storage APIs
seemed non-functional last time I tried to use them.

View File

@@ -0,0 +1,3 @@
\namespace gamedata
\internal
\brief Contains everything related to the virtual filesystem.

View File

@@ -0,0 +1,2 @@
This uses <a href="https://rant-lang.org">Rant</a>, a procedural generation language, along with a compiled in
wordlist module from a third party wordlist, to generate a unique and occasionally silly item description.

9
res/doc/python/items.md Normal file
View File

@@ -0,0 +1,9 @@
\namespace items
\brief Game logic related to items and resources.
This module handles generating of items, each worth a given amount of resources. The values are first calculated
according to game rules defined in XML files, then any given modifiers are applied.
\internal
\note This module is almost fully VFS aware.
\endinternal

2
res/doc/python/tick.md Normal file
View File

@@ -0,0 +1,2 @@
\namespace tick
\brief All logic related to game ticks.

View File

@@ -0,0 +1,2 @@
\namespace upgrades
\brief Upgrade tree related functions.