Home

Welcome to the Jex Example Plugin wiki!

Getting Started

Downloading Jex Client Dev Jar

To get started, we will need to download Jex and build it to get a development jar to ensure you are compatible with the latest version.

1. Download Jex Client git clone https://github.com/DustinRepo/JexClient.git
2. Open the Jex Client folder and run ./gradlew build
3. Find the file build/libs/jex-plugin-dev.jar in the JexClient folder and save it for later

Setting up the project

1. Download this project. git clone https://github.com/DustinRepo/JexExamplePlugin.git
2. Create a folder called lib in the project folder and put the jex-plugin-dev.jar in there from earlier
3. Open build.gradle in Intellij as a gradle project and wait for it to set up
4. File -> Close Project if you do not have a run configuration, then re-open the project
5. Edit the JexPlugin.json to specify the plugin name, description, authors, main class, etc.
6. Rename exampleplugin.mixins.json and edit it's reference in JexPlugin.json
7. Edit the gradle.properties file to specify the same Minecraft version and Yarn Mappings as Jex which you can find here
8. To test, just run the "Minecraft Client" run configuration
9. When ready to distribute, run ./gradlew build and the output will be in build/libs/

You should now have a working Jex Plugin project