Skip to content

Template repository for creating Mixin-enabled Forge mods

License

Notifications You must be signed in to change notification settings

Stefan0436/ForgeMixinModTemplate

Repository files navigation

LICENSE NOTE

This repository uses ForgeGradle, MixinGradle and Mixin.
Those projects belong to their rightful owners.

Project info

This is a simple template for forge mods with Mixin-support build-in.

Mod policy

For Mixin-enabled mods, you need Forge coremods and those must adhere to the following conditions:

  • Disclose source (mandatory, keep it FOSS, Free Open Source Software)
  • Proper exception handling in mixins/transformers (mandatory)
  • Coremod in separate jar from normal mods (mandatory)
  • Jars must be signed before distributing (mandatory)

Project setup

Main setup

  1. Clone the git
  2. Run the command: cd ForgeMixinModTemplate
  3. If you are using Linux or MacOS, run: chmod ug=rwx gradlew

IDE Setup: If you are using Eclipse-JEE (fully functional):

  1. Run the following commands depending on your OS:
  2. Windows: gradlew genEclipseRuns eclipse
  3. Linux/MacOS: ./gradlew genEclipseRuns eclipse

  1. Open Eclipse-JEE and open your workspace
  2. If you have the welcome page open, click 'Workbench' or 'Hide' in the top right corner
  3. Press the keys: ALT+F
  4. Click Import
  5. Open the category 'Gradle' and select 'Existing Gradle Project'
  6. Click next until you get to the import page
  7. Click browse (next to the 'Project root directory' box)
  8. Select the mod development kit folder
  9. Click Finish

IDE Setup: If you are using IntelliJ (not tested):

  1. Run the following commands depending on your OS:
  2. Windows: gradlew genIntellijRuns
  3. Linux/MacOS: ./gradlew genIntellijRuns
  4. Search online for importing a Forge project in IntelliJ

Mod Setup:

  1. Upcoming

Mod template information:

  • Mod loader: Forge
  • Minecraft version: 1.16.4
  • Default Mixin target version: 0.8.2
  • Default minimal Mixin version: 0.7.10
  • Forge version: 1.16.4-35.1.3
  • ForgeGradle version: 3+
  • MixinGralde version: 0.7-SNAPSHOT