Contributing to Kauri

Setting up your Workspace

Are you ready to contribute? Well first, we need to get you setup.

Requirements

• Kauri requires JDK 17 with Language Level configured to 8. This is so 1.17+ Minecraft libraries can load
• Ensure to have the latest version of Maven and Git installed
• We recommend using a modern IDE like Eclipse or IntelliJ

Getting started

1. Clone https://github.com/funkemunky/Kauri.git onto your computer.
2. Run mvn clean install in the project.
3. You're ready to go!

General Guidelines for Code Submission

• You must follow Java Naming Conventions
• The line that you probably think is just a bug on your IDE is actually a margin line. Make sure none of your code goes past that line!
• Use 4-character spacing
• Do not submit project files, or really any files that don't end in .java. If you're finding that git keeps tracking random files, configure your .gitignore to ignore them!
• Make sure your code has been tested
• Not every Pull Request will be accepted. While it is greatly appreciated that you want to contribute, sometimes certain changes don't align with our vision or don't meet the standards of the project.

Rules for Detection Submission

While we don't expect the community to submit fully tested and production-ready detections, we do want at minimum something that primary contributors to Kauri can work with.

Please:

• Test your detections on all popular Minecraft versions: 1.7.10, 1.8.9, 1.12.2, and whatever is the latest version. Make sure there aren't false positives or errors.
• Make sure the detection isn't redundant. We don't want multiple detections looking for the exact same thing in a slightly different way.
• Ensure your detection actually works. It would be a waste of CPU cycles if it doesn't actually detect any cheats.
• Anything unnecessarily heavy will usually be denied or not accepted until code is optimized. Unoptimized code can cause major problems for performance in an anti-cheat.