Skip to content

Contributing

JonataOliveiraa edited this page Nov 14, 2026 · 1 revision
Contributing

Thanks for helping. Bug reports, mods, documentation fixes and code are all welcome.

Before you start

  • Read LICENSING.md. Bunny Loader is source-available under the PolyForm Noncommercial License 1.0.0, not under an OSI license.
  • The game binaries and data are not in the repository, and never will be. Do not commit Terraria files (.so, global-metadata.dat, data.unity3d, dumps from refs/), the Unity classes, the Andy font, keystores or tokens. .gitignore already blocks the usual paths.
  • Mods do not go in this repository: each mod is its own package, and Making mods explains how to make one.
  • Code style: identifiers, logs and error messages in English; texts the player sees go through the translation files; documentation lives in this wiki, in English. Commit messages in English.

Contributor License Agreement (CLA)

By opening a pull request, you agree to the terms below for everything you submit to this project (code, documentation, art and anything else, together "your contribution").

  1. You can grant it. Your contribution is your own original work, or you have the right to submit it under these terms. If your employer has rights over your work, you have their permission.
  2. License to the project. You grant JonataOliveiraa, the maintainer of Bunny Loader, and anyone who receives the project from them, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, reproduce, modify, distribute, sublicense and relicense your contribution, under the project's current license or any other license, including commercial licenses granted to third parties.
  3. Patents. You grant the same parties a perpetual, worldwide, non-exclusive, royalty-free, irrevocable patent license for any of your patent claims that your contribution would infringe, to make, use, sell and distribute it as part of the project.
  4. You keep your copyright. This agreement does not transfer ownership. You may use your own contribution in any way you like.
  5. Third-party material. If part of your contribution comes from someone else, say so in the pull request, with its source and license. MIT, BSD and Apache-2.0 code is fine when the notice comes along; GPL code cannot be accepted.
  6. No warranty. Your contribution is provided "as is".

Why a CLA: the project's license may change in the future (for example, to a more permissive one), and the maintainer may grant commercial exceptions. Without the agreement, every such change would need the consent of every contributor.

The pull request template has a checkbox for this. A pull request without it checked will not be merged.

Pull requests

  • One topic per pull request.
  • Say what you tested and where: MuMu, a real phone (model and Android version), and the game version.
  • Keep generated files out unless the change is about them.

Building from source →

Clone this wiki locally