frostoven/Cosmosis

[Parent issue] Developer documentation

aggregate1166877 opened this issue · 0 comments

Subtasks

For now, while the project is small, all documentation TODOs will be listed here. As the project grows however, documentation TODOs will need to be raised as individual issues instead.

Tasks:

  • Document getting profile data (using both userProfile.cacheChangeEvent and userProfile.getCurrentConfig).
  • Document the shader creation process.
  • Spaceship modding docs are very out of date and no longer work. Needs updating (this is on hold until the modules system is implemented).
  • Document how to create a new profile sub-config JSON file that Cosmosis can understand.
  • Document the modding process.

Brief description

Documentation for contributors and modders.

Definition of done

This is a recurring task and will likely never close.

Full description

TBA