Thank you for your interest in contributing to Clangen!
If you would like to contribute writing, art, or a major gameplay feature, please apply for a developer role on our Discord. This is so that we can better coordinate the style and overall direction of the game.
For quality-of-life changes, bug fixes, minor enhancements (such as balance and customization), or any open issues, feel free to make a Pull Request. You do not have to be on the Discord or have a developer role on the Discord to submit a Pull Request.
The following instructions assume that you have already installed Python, and the working directory in your terminal is clangen.
When using Python, a virtual environment is recommended in order to increase reliability and more closely resemble our build environment. Instructions for setting up a virtual environment can be found here.
After you have set up and activated your virtual environment, run:
python3 pip install -r requirements.txtYou may have to replace python3 in the above command with python or py depending on your environment.
Poetry is a tool used for Python dependency management and packaging. Poetry will automatically set up and manage your virtual environment for you. Installation instructions for Poetry can be found here.
To install requirements using Poetry:
poetry installThen run using:
poetry run python main.pyIf you find a bug, please report it on our issues page.
When solving an issue, please link it in your Pull Request.
If you do not know where to get started, check the good first issue tag. These issues have been marked as “good first issues” because they are non-urgent improvements that do not require a great familiarity with the larger codebase. Solving these issues is a great way to better understand the codebase.