Just some small utilities for sandbox/modding
Several useful utilities for testing stuff in sandbox:
Other non-in-game features:
Original repo here: MEEPofFaith/testing-utilities-js.
gradlew jar
[1].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.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:
Building locally takes more time to set up, but shouldn't be a problem if you've done Android development before.
ANDROID_HOME
environment variable to its location.30.0.1
installed, that would be $ANDROID_HOME/build-tools/30.0.1
.gradlew deploy
. If you did everything correctlly, this will create a jar file in the build/libs
directory that can be run on both Android and desktop.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.
[1] On Linux/Mac it's ./gradlew
, but if you're using Linux I assume you know how to run executables properly anyway.
[2]: Yes, I know this is stupid. It's a Github UI limitation - while the jar itself is uploaded unzipped, there is currently no way to download it as a single file.