If you are interested in contributing to this project via issues or PRs, please follow these guidelines.
If you are reporting a bug, please include a log, or at the very least the relevant stack trace. NeosModLoader logs to the Neos log by default (C:\Program Files (x86)\Steam\steamapps\common\NeosVR\Logs).
If you want your PR to be approved and merged quickly, please read the following:
If your PR does not follow the project's code style it will not be approved. Code style should match our editor config. If you aren't sure, use your IDE's formatter (Analyze > Code Cleanup in Visual Studio).
Please consider the NML design goals before adding a new feature. If you aren't sure if your new feature makes sense for NML, I'm happy to talk with you about a potential new feature in our discussions area.
- NML should be kept as simple as possible. Its purpose is to load mods, not mod Neos itself. Additionally, NML is not intended to fix Neos bugs. Please do not attempt to add Neos bugfixes directly to NML. Instead, ensure there's an issue open on the Neos issue tracker, and only consider making a mod if the Neos team is unable to provide a fix in a reasonably timeframe.
- NML should only create APIs where the added API complexity is paid for by added ease of development for mod creators. If a proposed API is only useful to a very small percentage of mods, NeosModLoader probably isn't the place for it.
- NML should try to prevent mod developers from shooting themselves in the foot. For example, NML only supports mods with a single NeosMod implementation. Instead of silently ignoring extra implementations in a mod, NML will instead throw an error message and abort loading the mod entirely.