setup mixins using GTNH IMixins system

Author: Alexdoru

gradle.properties

@@ -74,26 +74,26 @@ apiPackage =
 accessTransformersFile =
 
 # Provides setup for Mixins if enabled. If you don't know what mixins are: Keep it disabled!
-usesMixins = false
+usesMixins = true
 
 # Set to a non-empty string to configure mixins in a separate source set under src/VALUE, instead of src/main.
 # This can speed up compile times thanks to not running the mixin annotation processor on all input sources.
 # Mixin classes will have access to "main" classes, but not the other way around.
 separateMixinSourceSet =
 
 # Adds some debug arguments like verbose output and class export.
-usesMixinDebug = false
+usesMixinDebug = true
 
 # Specify the location of your implementation of IMixinConfigPlugin. Leave it empty otherwise.
 mixinPlugin =
 
 # Specify the package that contains all of your Mixins. You may only place Mixins in this package or the build will fail!
-mixinsPackage =
+mixinsPackage = mixins
 
 # Specify the core mod entry class if you use a core mod. This class must implement IFMLLoadingPlugin!
 # This parameter is for legacy compatibility only
 # Example value: (coreModClass = asm.FMLPlugin) + (modGroup = com.myname.mymodid) -> com.myname.mymodid.asm.FMLPlugin
-coreModClass =
+coreModClass = mixins.EarlyMixinsLoader
 
 # If your project is only a consolidation of mixins or a core mod and does NOT contain a 'normal' mod ( = some class
 # that is annotated with @Mod) you want this to be true. When in doubt: leave it on false!

src/main/java/com/myname/mymodid/mixins/EarlyMixinsLoader.java

@@ -0,0 +1,49 @@
+package com.myname.mymodid.mixins;
+
+import com.gtnewhorizon.gtnhmixins.IEarlyMixinLoader;
+import com.gtnewhorizon.gtnhmixins.builders.IMixins;
+import cpw.mods.fml.relauncher.IFMLLoadingPlugin;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+@IFMLLoadingPlugin.MCVersion("1.7.10")
+public class EarlyMixinsLoader implements IFMLLoadingPlugin, IEarlyMixinLoader {
+
+    @Override
+    public String[] getASMTransformerClass() {
+        return null;
+    }
+
+    @Override
+    public String getModContainerClass() {
+        return null;
+    }
+
+    @Override
+    public String getSetupClass() {
+        return null;
+    }
+
+    @Override
+    public void injectData(Map<String, Object> data) {}
+
+    @Override
+    public String getAccessTransformerClass() {
+        return null;
+    }
+
+    @Override
+    public String getMixinConfig() {
+        // rename the associated .json file by replacing the "mymodid" with your own mod ID
+        // in the .json file edit the "package" and "refmap" properties to match your mod
+        // also edit the "refmap" property in the "mixins.mymodid.json" file
+        return "mixins.mymodid.early.json";
+    }
+
+    @Override
+    public List<String> getMixins(Set<String> loadedCoreMods) {
+        return IMixins.getEarlyMixins(Mixins.class, loadedCoreMods);
+    }
+}

src/main/java/com/myname/mymodid/mixins/LateMixinsLoader.java

@@ -0,0 +1,30 @@
+package com.myname.mymodid.mixins;
+
+import com.gtnewhorizon.gtnhmixins.ILateMixinLoader;
+import com.gtnewhorizon.gtnhmixins.LateMixin;
+import com.gtnewhorizon.gtnhmixins.builders.IMixins;
+
+import javax.annotation.Nonnull;
+import java.util.List;
+import java.util.Set;
+
+// The annotation is required, it indicates to
+// the mixins framework to instantiate this class
+// and look for LateMixins to load.
+@LateMixin
+public class LateMixinsLoader implements ILateMixinLoader {
+
+    @Override
+    public String getMixinConfig() {
+        // rename the associated .json file by replacing the "mymodid" with your own mod ID
+        // in the .json file edit the "package" and "refmap" properties to match your mod
+        // also edit the "refmap" property in the "mixins.mymodid.json" file
+        return "mixins.mymodid.late.json";
+    }
+
+    @Nonnull
+    @Override
+    public List<String> getMixins(Set<String> loadedMods) {
+        return IMixins.getLateMixins(Mixins.class, loadedMods);
+    }
+}

src/main/java/com/myname/mymodid/mixins/Mixins.java

@@ -0,0 +1,29 @@
+package com.myname.mymodid.mixins;
+
+import com.gtnewhorizon.gtnhmixins.builders.IMixins;
+import com.gtnewhorizon.gtnhmixins.builders.MixinBuilder;
+
+import javax.annotation.Nonnull;
+
+public enum Mixins implements IMixins {
+
+    // Read the java doc of IMixins and MixinBuilder for further information
+
+    // You should declare all of your mixins early and late in this same enum
+
+    EXAMPLE(new MixinBuilder()
+        .setPhase(Phase.EARLY)
+        .addClientMixins("MixinMinecraft_Example"));
+
+    private final MixinBuilder builder;
+
+    Mixins(MixinBuilder builder) {
+        this.builder = builder;
+    }
+
+    @Nonnull
+    @Override
+    public MixinBuilder getBuilder() {
+        return builder;
+    }
+}

src/main/java/com/myname/mymodid/mixins/TargetMods.java

@@ -0,0 +1,28 @@
+package com.myname.mymodid.mixins;
+
+import com.gtnewhorizon.gtnhmixins.builders.ITargetMod;
+import com.gtnewhorizon.gtnhmixins.builders.TargetModBuilder;
+
+import javax.annotation.Nonnull;
+
+public enum TargetMods implements ITargetMod {
+
+    // Read the java doc of ITargetMod and TargetModBuilder for further information
+
+    // Add to this enum information about the mods you need to identify during runtime
+
+    COFHCORE("cofh.asm.LoadingPlugin", "CoFHCore"),
+    OPTIFINE("optifine.OptiFineForgeTweaker", "Optifine");
+
+    private final TargetModBuilder builder;
+
+    TargetMods(String coreModClass, String modId) {
+        this.builder = new TargetModBuilder().setCoreModClass(coreModClass).setModId(modId);
+    }
+
+    @Nonnull
+    @Override
+    public TargetModBuilder getBuilder() {
+        return builder;
+    }
+}

src/main/java/com/myname/mymodid/mixins/early/MixinMinecraft_Example.java

@@ -0,0 +1,18 @@
+package com.myname.mymodid.mixins.early;
+
+import net.minecraft.client.Minecraft;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Inject;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+
+@Mixin(Minecraft.class) // the class targeted by this mixin
+public class MixinMinecraft_Example { // This is an example you should delete this class
+
+    @Inject(method = "startGame", at = @At("TAIL"))
+    private void example$sayHello(CallbackInfo ci) {
+        // this line of code will be injected at the end of the method "startGame" in the Minecraft class
+        System.out.println("Example mod says Hello from within Minecraft.startGame()!");
+    }
+}

src/main/resources/mixins.mymodid.early.json

@@ -0,0 +1,8 @@
+{
+  "required": true,
+  "minVersion": "0.8.5-GTNH",
+  "package": "com.myname.mymodid.mixins.early",
+  "refmap": "mixins.mymodid.refmap.json",
+  "target": "@env(DEFAULT)",
+  "compatibilityLevel": "JAVA_8"
+}

src/main/resources/mixins.mymodid.json

@@ -0,0 +1,7 @@
+{
+  "required": true,
+  "minVersion": "0.8.5-GTNH",
+  "refmap": "mixins.mymodid.refmap.json",
+  "target": "@env(DEFAULT)",
+  "compatibilityLevel": "JAVA_8"
+}

src/main/resources/mixins.mymodid.late.json

@@ -0,0 +1,8 @@
+{
+  "required": true,
+  "minVersion": "0.8.5-GTNH",
+  "package": "com.myname.mymodid.mixins.late",
+  "refmap": "mixins.mymodid.refmap.json",
+  "target": "@env(DEFAULT)",
+  "compatibilityLevel": "JAVA_8"
+}