relace
Build & Development Commands
Use Gradle to build and run your mod:
./gradlew build to compile and package your mod into a .jar file. The output will be in the build/libs directory.
./gradlew runClient to launch Minecraft with your mod loaded for local testing.
./gradlew runServer to start a Minecraft server with your mod for multiplayer testing.
Ensure your build.gradle includes the correct dependencies for Fabric Loader and Fabric API, using the Maven repositories listed in your docs.
Keep your development environment and dependencies up to date with the latest Fabric Loader, Fabric API, and Minecraft 1.21.4 versions.
Testing Guidelines
Write unit tests using Fabric Loader JUnit for code logic and helpers. Add testImplementation "net.fabricmc:fabric-loader-junit:${project.loader_version}" to your build.gradle.
Configure Gradle to use JUnit Platform for running tests.
Use the Gametest framework for automated in-game feature and gameplay testing.
Test your mod in both single-player and multiplayer environments to ensure compatibility.
Use CI (Continuous Integration) like GitHub Actions to automate your test suite on every build.
Code Style & Guidelines
Follow standard Java conventions for naming, formatting, and structure.
Use JavaDoc for all public classes and methods to document your code.
Organize your code by features (e.g., items, blocks, events) for clarity and maintainability.
Avoid deprecated APIs and keep your code updated for the latest Fabric changes.
Prefer using Fabric API modules over custom implementations when possible for better compatibility and maintainability.
Use proper package naming and modid conventions as described in the Fabric Wiki.
Documentation Guidelines
Maintain a clear and concise README with your mod's description, installation instructions, and dependencies.
Document all public APIs and major features with JavaDoc.
Include usage examples and troubleshooting steps in your documentation.
Update documentation whenever you make significant changes to your codebase.
Host your documentation on a public platform (e.g., GitHub or Modrinth) for community access and collaboration.
Reference official Fabric documentation and release notes for advanced topics and version-specific changes.
No Prompts configured
No Data configured
npx -y perplexity-mcp