New contributions will not be accepted unless you agree to and sign this CLA. The signing process is automatic and should not in any way affect your ability to contribute. This is only required to protect the repository against possible legal issues in the future.
- For commiting, we encourage Conventional Commits.
- We encourage access modifiers to be specified explicitly with no exceptions.
- Keep access modifiers as strict as possible (E.G: Do not default everything to
publicwhen they're not meant for public access). - Unity messages (Awake, Start, Update etc..) should always be
private. - Remove unused
usingstatements. Many IDEs offer shortcuts to perform this action. - For namespaces, use File Scoped Namespaces.
- Download and install .NET 7
- Fork & clone the repository
- Open the solution (.sln) file with your favorite IDE
- Restore the dependencies by performing a NuGet restore via your IDE or by simply executing
dotnet restorein a terminal - Make your changes, then submit a pull request.
We expect submitted PRs to be functional and thoroughly tested in the game. Please make sure of the following:
- Your changes do not break existing mods. Be it in a new world/save, or existing ones
- Follow our Pull Request Template
- Run code refactoring automations to match our preferred styles.
If you are new to pull requests, read through GitHub's Guide.
If you're looking to contribute to the docs, refer to our Docs Guidelines.