Thanks for helping with MCHeli Rework. Bug reports, fixes and new features are welcome. Please read this page first; pull requests that skip these rules will be asked to change before merging.
MCHeli's vehicles, models, textures, sounds and HUD scripts are EMB4's work and All Rights
Reserved. They are not in this repository and must never be added, not even a single texture.
Players import them from their own copy of MC1.7.10_mcheli_1.0.3.zip (see the README).
- Do not commit anything from the zip, from
run/mcheli/importedor frombuild/legacy-content. - Do not attach original files to issues; name the vehicle instead.
- Screenshots and short clips of the game are fine.
See docs/DEVELOPMENT.md. In short: JDK 25, put the original zip in
Mod/ (git-ignored), then ./gradlew build. Without the zip the build passes but the content
tests are skipped, as on CI, so run the tests with the zip before opening a pull request that
touches content loading, models or HUDs.
- Fork the repository, or create a branch if you have access:
git checkout main && git pull, thengit checkout -b <type>/<topic>, for examplefix/rotor-pivotorfeat/night-vision. - Make the change, with tests where the code allows it (the
content,modelandhudpackages are plain Java and easy to test). - Update CHANGELOG.md under
Unreleased(Keep a Changelog format) and the relevant page indocs/: ARCHITECTURE.md for design changes, TESTING.md for anything that needs an in-game check,docs/contentfor definition keys. - Commit and open a pull request against
main. CI must pass, andmainonly accepts changes through pull requests.
- Signed commits only (
git commit -S).mainrejects unsigned commits. See GitHub's guide to signing commits. - One file per commit, with a message saying what changed in that file and why. A deleted or moved file is its own commit. Order the commits so each one builds where practical.
- Plain, specific messages in the imperative: "Fix the tail rotor pivot on the AH-64", not "fixes" or "update file".
- Code reads like the code around it: same naming, comment density and structure. Keep the
content,modelandhudpackages free of Minecraft and Forge imports. - Comments, docs and messages are written plainly, the way an experienced developer writes them. No marketing tone, no filler, and no em-dashes (use commas, colons, parentheses or a plain hyphen).
- Java files are UTF-8 with LF line endings (
.gitattributestakes care of this).
Use the bug report template. Attach logs/latest.log (and the crash report, if there is one),
name the vehicle, and say what you did and what you expected.