Contributions are welcome if they meet the following criteria:
-
Language is english.
-
Code should be StyleCop compliant - this project uses the StyleCop.Analyzers for VS2022 so you should see issues directly as warnings.
-
Coding style (naming, etc.) and quality should fit to the current state.
-
No code copied/converted from the well-known decompiled source of the original server.
If you want to contribute, please create a new issue for the feature or bug (if the issue doesn't exist yet) so we can see who is working on something and can discuss possible solutions. If it's a small thing, you can also just send a pull request without adding an issue.
Apart of that, contributions from non-developers are welcome as well. You can test the server, submit issues or suggestions, packet descriptions or documentations about the concepts and mechanics of the game itself. Please use markdown files/syntax for this purpose.
If you have questions about that, don't hesitate to ask in our discord channel or by submitting an issue.
- fork this project from the original MUnique OpenMU Project.
- create a feature branch from the master branch
- commit your changes to your feature branch
- please test your changes, don't send AI generated code without testing it yourself
- submit a pull request to the original master branch
- wait for the code review and merge :)
- Run from source - building and debugging the server
- Architecture - how the server is structured internally
- Solution structure - what lives in which project
- The plugin system - how most features are implemented, and how to write your own plugin
The documentation website is built from the docs-website folder. Every page has an Edit this page link at the bottom which leads to its source file. To run it locally:
cd docs-website
npm install
npm startThe deeper, code-bound technical documentation stays next to the code, in
docs and in the Readme.md files of the projects under src.