Differences From
Artifact [912982b94d]:
1 1 # starlit development
2 -this file contains information meant for those who wish to develop for Starsoul or build the game from trunk. do NOT add any story information, particularly spoilers; those go in src/lore.ct.
2 +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.
3 3
4 4 ## tooling
5 5 starlit uses the following software in the development process:
6 6 * [*csound] to generate sound effects
7 7 * [*GNU make] to automate build tasks
8 8 * [*lua] to automate configure tasks
9 9
10 10 ## building
11 -to run a trunk version of Starsoul, you'll need to install the above tools and run `make` from the base directory. this will:
11 +to run a trunk version of Starlit, you'll need to install the above tools and run `make` from the base directory. this will:
12 12 * run lua scripts to generate necessary makefiles
13 13 * generate the game sound effects and install them in mods/starlit/sounds
14 14
15 15 ## policy
16 16 * copyright of all submitted code must be reassigned to the maintainer.
17 17 * all code is to be indented with tabs and aligned with spaces; formatting is otherwise up to whoever is responsible for maintaining that code
18 18 * use [`camelCase], not [`snake_case] and CERTAINLY not [`SCREAMING_SNAKE_CASE]
19 19 * sounds effects should be contributed in the form of csound files; avoid adding audio files to the repository except for foley effects