Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (76 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

82 lines (76 loc) · 2.91 KB

Contributor's Guide

Please make sure to make your pull requests off the development branch if you're adding new features. If there's an important bug fix, still make your PR on development, but put it in a separate commit so I can cherry-pick it into master branch. Thank you!

# Not recommended
git checkout -b development --track origin/development

Requirements

  • IDE (One of them)
  • (Plugin) Lombok to help with things such as not having to manually create Getters and Setters.
    • IntelliJ IDEA
      • After installing the plugin
        • Go to Preferences
        • Go to Build, Execution, Deployment
        • Go to Compiler
        • Go to Annotation Processors
        • Check ☑ Enable annotation processing.
    • Eclipse

Getting started

Note: You can use gradle instead of using gradle wrapper ./gradlew.

  1. Clone the repository

  2. Setup the development environment

    ./gradlew setupDecompWorkspace

  3. Integrate the development environment with your IDE

    • IntelliJ IDEA
    ./gradlew idea genIntellijRuns
    • Eclipse (doesn't generate debug configuration)
    ./gradlew eclipse
    • (Eclipse) Change Text File Encoding from Default to UTF-8
      • Go to Window -> Preferences -> General -> Workspace
      • Change Text File Encoding from Default to UTF-8

  4. Make sure to add the VM argument to your debug configuration

    -Dfml.coreMods.load=codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin

  5. Include your Minecraft username and password as arguments in the debug configuration. In order, to login into Hypixel by your account.

    --username "<username>" --password "<password>"

    Note: Don't share your password with anyone. We aren't going to ask you about your password!

  6. You are now ready to build the mod!

How to build

  1. Build the mod 
    ./gradlew build

    Note

    If your jar build is failing because the code is trying to access private methods or fields, this may be because someone added some new access transformers.

    You may want to re-run the gradle task

    ./gradlew setupDecompWorkspace

    so the access transformers are applied to the source code!

  2. (Optional) Run the Minecraft Forge client
    • Using an IDE
      • Run the debug configuration you created in "Getting Started."
    • Using the command line
    ./gradlew runClient --args="--username <username> --password <password>"