Contributing to ViaFabricPlus

March 29, 2026 ยท View on GitHub

Thanks for your interest in contributing! This guide will walk you through setting up a workspace, updating translations, adding features, and maintaining high-quality contributions.

Setting Up a Workspace

ViaFabricPlus uses Gradle. Make sure you have it installed: Gradle Installation Guide.

  1. Clone the repo:

    git clone https://github.com/ViaVersion/ViaFabricPlus

  2. Enter the project folder:

    cd ViaFabricPlus

  3. Generate sources:

    ./gradlew genSources

  4. Open the project as a Gradle project in your preferred IDE.

  5. Run the mod

Updating Translation Files

If you want to help translating ViaFabricPlus you can do so on Crowdin.

Adding a New Feature or Fixing a Bug

  1. Start from the current active ver/<version> branch.
  2. Create a branch (e.g. feature/fix-xyz or fix/fix-xyz).
  3. Open your pull request against that same ver/<version> branch.
  4. Implement and test your changes thoroughly.
  5. Write clean, readable code (descriptive names, no clutter).
  6. Follow Google's Java Code Style.
  7. If you modify the API:
    • Update documentation in docs/
    • Add Javadocs to your code
    • Avoid breaking backwards compatibility unless absolutely necessary
  8. Open a pull request and wait for review.

Adding Protocol Fixes

Protocol fixes are the heart of ViaFabricPlus. They're what make this project unique, so it's important to add only relevant and correct changes.

Guidelines for fixes:

  • Only add fixes that affect gameplay or server communication
  • Avoid purely visual-only tweaks
  • If unsure, ask in the ViaVersion Discord
  • Most useful fixes usually involve movement or networking

Proof is required:

  • Show that your fix matches real game changes
  • Provide a source diff (if available)

Remember: fixes should reflect actual historical behavior, not cosmetic adjustments.

Maintaining the Mod

For details on ongoing development, see MAINTAINING.md.