# starlit development
this file contains information meant for those who wish to develop for Starlit or build the game from trunk. do NOT add any story information, particularly spoilers; those go in src/lore.ct.

## tooling
starlit uses the following software in the development process:
* [*csound] to generate sound effects
* [*GNU make] to automate build tasks
* [*lua] to automate configure tasks

## building
to run a trunk version of Starlit, you'll need to install the above tools and run `make` from the base directory. this will:
* run lua scripts to generate necessary makefiles
* generate the game sound effects and install them in mods/starlit/sounds

## policy
* copyright of all submitted code must be reassigned to the maintainer.
* all code is to be indented with tabs and aligned with spaces; formatting is otherwise up to whoever is responsible for maintaining that code
* use [`camelCase], not [`snake_case] and CERTAINLY not [`SCREAMING_SNAKE_CASE]
* sounds effects should be contributed in the form of csound files; avoid adding audio files to the repository except for foley effects
