We appreciate your interest in contributing to this project! Below are some guidelines to ensure smooth collaboration and to streamline the process of getting your contributions incorporated into the project.
We welcome contributions of new packet structures. However, there are some conditions to keep in mind:
-
The packets should be already established and consumed by emulators (like the Freeshard/UOG packets) or add new functionality that can be useful in a broad context.
-
When submitting a new packet structure, including a reference implementation is highly recommended. It will increase the chances of your contribution being accepted.
-
Not all packets will be accepted if they are too shard-specific, and not reusable outside of that shard. We are looking for contributions that benefit a wide range of emulators and shards.
-
You must have explicit approval from the creator of the packet to include it in the project. Alternatively, the packet should be publicly released or available under an open-source license.
-
Fork this repository.
-
Create a new branch in your fork for your changes. Name the branch something descriptive, such as
new-packet-xyz. -
Make your changes in your new branch.
-
Submit a pull request from your branch in the forked repository to the main repository. Make sure to include a clear description of your changes in the pull request.
-
Respond to any feedback and make changes as necessary.
As contributors and maintainers of this project, we are committed to providing a friendly, safe, and welcoming environment for all. Please respect everyone and follow accepted guidelines for professional and respectful communication.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Any unacceptable behavior should be reported by contacting the project team.
Thank you for contributing to this project and making the UO community a better place!