Skip to content

Commit

Permalink
[docs] stub out kernel doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jd28 committed Oct 11, 2024
1 parent 3fabdf8 commit a0837c1
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions docs/structure/kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,43 @@ kernel
The ``kernel`` module provides submodules for handling global resources
and services. It's designed around some explicit goals:

- Any function or object that can modify global state must be contained
in this module for easy search/grepability. ``using nwk = nw::kernel`` is an acceptable abreviation.
- Every service should be easily overrideable to allow for `parallel
implementation <http://sevangelatos.com/john-carmack-on-parallel-implementations/>`__.
- Every service should be decoupled from the kernel itself.
- Any function or object that can modify global state must be contained
in this module for easy search/grepability.

Config
~~~~~~

:cpp:struct:`nw::kernel::Config`

Services
--------

Config
~~~~~~
EffectSystem
------------

EventSystem
-----------

FactionSystem
-------------

ModelCache
----------

ObjectSystem
------------

Rules
-----

Strings
-------

TilesetRegistry
---------------

The ``Config`` service provides access to installation info.
TwoDACache
----------

0 comments on commit a0837c1

Please sign in to comment.