https://github.com/ddozzi/mixin-tutorial

https://github.com/ddozzi/mixin-tutorial

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/ddozzi/mixin-tutorial
• Owner: ddozzi
• Created: 2021-07-21T05:31:26.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-08-29T22:07:50.000Z (almost 5 years ago)
• Last Synced: 2024-08-04T20:52:13.475Z (almost 2 years ago)
• Language: Java
• Size: 42 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
### this tutorial is no longer being maintained!

### for a more up-to-date and in-depth tutorial, check out [my new tutorial!](https://ddozzi.gitbook.io/mixin-tutorial/how-to-make-a-mixin-client/) 

### thanks for all the support!

# Mixin Tutorial - INTELLJI

I haven't seen any decent mixin tutorials, so here's one.

## Topics

- Setting up your first mixin project

- Creating your first mixin

## Setup

Create a new folder where ever you want your client to be. 

![Example Client](https://user-images.githubusercontent.com/69029714/126436967-facffba9-a63e-4c8a-9cd6-3837cfe62a44.png)

Open up IntelliJ. Then click `New Project > Gradle > Next`. Set the `Location` to the folder you just created

![EC INTELLIJ](https://user-images.githubusercontent.com/69029714/126437646-557d291c-851d-424f-87ca-062d79c3461b.png)

Copy and paste the ![build.gradle](https://github.com/ddozzi/Mixin-Tutorial/blob/main/build.gradle) into your `build.gradle`.

![EC INTELLIJ 2](https://user-images.githubusercontent.com/69029714/126437757-62a7b876-785b-41d4-928d-04e841f3685a.png)

Then click the "Load Gradle Changes" Button on the top right.

![refresh button](https://user-images.githubusercontent.com/69029714/126437993-ae1b7358-0335-4651-8cb5-1fdc0d716383.png)

You might be noticing an error popping up in the bottom half, that's totally normal. It's because forgegradle doesn't support newer versions of gradle.

![Screen Shot 2021-07-21 at 1 52 50 AM](https://user-images.githubusercontent.com/69029714/126438050-42e89148-3242-44b7-8c84-c977efb74350.png)

To fix this, go to `gradle > wrapper > gradle-wrapper.properties` then replace whatever version is currently there, with 4.7

https://user-images.githubusercontent.com/69029714/126439227-39686823-fe4f-49fe-bb84-0a86235286c0.mov

Now for the lengthy part. Replace all the "example" strings with your client name. Also replace the "net" packages with whatever fits you. An example is shown below.

**! This MUST be done for all instances. DO NOT CHANGE ANY OF THE "mixin" OR "mixins" strings !**

Once you are done, click the gradle button on the far right. Then click `Tasks > forgegradle > setupDecompWorkspace`. This will take some time.

![Screen Shot 2021-07-21 at 2 09 49 AM](https://user-images.githubusercontent.com/69029714/126439713-851590a2-9733-4ee3-8645-89234d3528e6.png)

Once that process is finished, click `Tasks > forgegradle > genIntellijRuns`

![Screen Shot 2021-07-21 at 2 10 32 AM](https://user-images.githubusercontent.com/69029714/126439793-ecbd06b3-632c-44e3-b28d-a43684b6db8f.png)

Click the button at the top then click `Minecraft Client` An example is shown below.

https://user-images.githubusercontent.com/69029714/126440150-9632bb22-8278-467e-ad86-425d15ffa2ec.mov

Click the same button again, then click `Edit Configurations`. You will see an error saying "Class 'GradleStart not found in module 'ExampleClient'". 

To fix this, set the `Client` to `Client.main`.

https://user-images.githubusercontent.com/69029714/126440865-81519283-7a34-4d12-bf6f-ea14ba94192d.mov

Click Apply. The error should be gone now.

## Tweaker

Create a new package in `src/main/java` with the package name you've set in your `build.gradle` in this case, it would be `net.example`

Create a new package named `mixins` inside the previous pacakge then create a new `java` file with whatever you named your tweaker. In this case, it's `ExampleTweaker`. 

**Copy the code from this ![tweaker]("https://github.com/ddozzi/Mixin-Tutorial/blob/main/ExampleTweaker.java") to yours.**

Replace the `example` at `Mixins.addConfiguration("mixins.example.json");` (inside your tweaker) with your client name or whatever you named your package.

So far, your project should look something like this: 

![Screen Shot 2021-07-21 at 2 28 07 AM](https://user-images.githubusercontent.com/69029714/126441740-f74f0274-1c95-4f0d-b609-fd847934db75.png)

## Mixin Time!

Now it's time to make your first mixin!

Create a new file named whatever was inside your `Mixins.addConfiguration("mixins.example.json");` inside the resource folder.

![Screen Shot 2021-07-21 at 2 36 44 AM](https://user-images.githubusercontent.com/69029714/126442702-69b7a10f-67be-4dea-9216-366b89469599.png)

Then, copy the json from ![here]("https://github.com/ddozzi/Mixin-Tutorial/blob/main/mixins.example.json") into the json file you just created.

Ok, now it's time to create an actual mixin.

Create a package named `client` inside the package where your tweaker is located.

Then, inside that `client` package, create a java file named `MixinMinecraft`

![Screen Shot 2021-07-21 at 2 39 38 AM](https://user-images.githubusercontent.com/69029714/126443045-7ea64cde-02c6-423a-ae11-704d9292b7b6.png)

then add this mixin code: 

```java

@Mixin(Minecraft.class)

public class MixinMinecraft {

    @Inject(method = "createDisplay", at = @At("RETURN"))

    public void createDisplay(CallbackInfo callbackInfo) {

        Display.setTitle("Example Client | 1.8.9");

    }

}

```

Congrats! You've made a mixin client for 1.8.9! For more guidance, join the spongepowered ![discord]("https://discord.gg/sponge") and check out this ![cheatsheet]("https://github.com/2xsaiko/mixin-cheatsheet")

**Having issues? Feel free to contact me on discord (ddozzi#6190), the code is also available ![here]("https://github.com/ddozzi/Mixin-Tutorial-Code/tree/main")**