Project EPL
A beta mindustry mod, this mod not uploaded on mindustry until a new release has been released. the way you can compile/implement it is in the text below
Building for Desktop Testing
- Install JDK 16.
- Run
gradlew jar
[1]. - Your mod jar will be in the
build/libs
directory. Only use this version for testing on desktop. It will not work with Android. To build an Android-compatible version, you need the Android SDK. You can either let Github Actions handle this, or set it up yourself. See steps below.
Building through Github Actions
This repository is set up with Github Actions CI to automatically build the mod for you every commit. This requires a Github repository, for obvious reasons. To get a jar file that works for every platform, do the following:
- Make a Github repository with your mod name, and upload the contents of this repo to it. Perform any modifications necessary, then commit and push.
- Check the "Actions" tab on your repository page. Select the most recent commit in the list. If it completed successfully, there should be a download link under the "Artifacts" section.
- Click the download link (should be the name of your repo). This will download a zipped jar - not the jar file itself [2]! Unzip this file and import the jar contained within in Mindustry. This version should work both on Android and Desktop.
Adding Dependencies
Please note that all dependencies on Mindustry, Arc or its submodules must be declared as compileOnly in Gradle. Never use implementation
for core Mindustry or Arc dependencies.
implementation
places the entire dependency in the jar, which is, in most mod dependencies, very undesirable. You do not want the entirety of the Mindustry API included with your mod.compileOnly
means that the dependency is only around at compile time, and not included in the jar.
Only use implementation
if you want to package another Java library with your mod, and that library is not present in Mindustry already.