Skip to content

Contributing

Rhys edited this page Jan 1, 2021 · 10 revisions

Eigengrau's Generator is compiled by Twine, but most of the code itself is JavaScript (Standard style). Front-facing code is SugarCube (which is then transpiled), which is a relatively simple (if extremely ugly) language. You can learn more about the syntax of SugarCube here. Learn how to compile a local version of the generator here.


All contributors should take a look at the Style Guide


Coders

If you are familiar with JavaScript and wish to contribute code, you may wish to look at the Game Design Document to familiarise yourself with the flow of the Generator. Refer to the Design Guide for New Features if you are building new things.

Non-coders

If you are not able to contribute code, that doesn't mean you can't contribute! There are plenty of writing tasks, since the generator is built out of a book's worth of random lists, and someone needs to make those lists. Refer to the Template Guide for how to get started.

Clone this wiki locally