Skip to content

Contributing To Development

Min T edited this page Feb 7, 2024 · 1 revision

Whether you're a user, a mod author, or a programmer, there are many ways to contribute to development of the engine!

Users

Bug Reports

Users of the program can help development by submitting good bug reports through Github's issue tracking system.


Provide Instructions on Reproducing the Problem

When submitting a bug report, please provide the steps that another user should take to reproduce the same issue. Always write your report under the assumption that the developers have no information about the bug, as is the case most of the time.


Provide Relevant Files

At the bare minimum, the Engine.log file should be submitted so that the author can look through the log messages for more information, as well as see the patch list of mods available.

Ideally, the entire output of the engine should be zipped up and attached to provide the most information possible.

Keep in mind that users are not in a position to decide which files will contribute to debugging the problem, unless they are familiar with the source code and behavior. When in doubt, include as many relevant files as possible.


Provide Visual Proof (optional)

Provide an image or video of the issue if possible.


Reports that follow very little or none of these guidelines will be ignored, and likely closed.

Please take some extra time to create a good report, so that developers can fix the issue quicker and easier.