Your contributions to this project can be one of the following three categories:
-
Bug Fixes
- If you find a bug, please create an issue.
- If you want to fix an issue, please comment on that issue stating your intention.
-
New Feature Proposals
- If you have a new feature in mind, please create an issue first. We will then discuss the design and implementation. Once we agree that the plan looks good, you can go ahead and implement it.
-
Documentation Refinement
- If you find something lacking in the documentation, please create an issue or improve the documentation directly by sending a Pull Request.
Once your contribution is ready, please send a Pull Request to [Your Repository Link].
To develop this project on your machine, follow these steps:
- Clone the repository:
git clone [Your Repository Link]
cd [Your Repository Folder]- Install the Python package in develop mode:
pip install -r requirements.txt
And install JDK 17.
For Python code, we follow the black coding style. There are no specific style rules for Kotlin code.
Before proposing a PR, please create an issue first to discuss the feature. This prevents duplicate PRs and eases the code review process.
Every PR needs to be reviewed and must pass the Continuous Integration tests.
All new features must add tests in the tests/ folder. The same applies when a bug fix is proposed.
- For creating Minecraft mods: FabricMC Wiki
- For Gymnasium environments: Gymnasium Documentation
- For Stable-Baselines3: Stable-Baselines3 Documentation
It is prohibited to take illegal advantage of Minecraft.