/alpha-example-mod

Primary LanguageJavaCreative Commons Zero v1.0 UniversalCC0-1.0

alpha-example-mod

Alpha 1.2.2a example mod

Installation

  1. Download and install MultiMC if you haven't already.
  2. If you haven't already, press "create instance", and press "import from zip", and paste the following URL into the text field: https://cdn.discordapp.com/attachments/666758878813487136/699323306637262928/fabric-alpha.zip
  3. Download alpha-example-mod from the releases page.
  4. Click on your new MultiMC instance and click "edit instance" on the right. Click "loader mods" then "add", and navigate to the mod you just downloaded, and press OK.

Contributing

  1. Clone the repository
    git clone https://github.com/pack-png-mods/alpha-example-mod
    cd alpha-example-mod
    
  2. Generate the Minecraft source code
    ./gradlew genSources
    
    • Note: on Windows, use gradlew rather than ./gradlew.
  3. Generate the IDE project depending on which IDE you prefer
    ./gradlew idea      # For IntelliJ IDEA
    ./gradlew eclipse   # For Eclipse
    
  4. Import the project in your IDE and edit the code
  5. After testing in the IDE, build a JAR to test whether it works outside the IDE too
    ./gradlew build
    
    The mod JAR may be found in the build/libs directory
  6. Create a pull request so that your changes can be integrated into alpha-example-mod
    • Note: for large contributions, create an issue before doing all that work, to ask whether your pull request is likely to be accepted