diff --git a/.github/workflows/commitTest.yml b/.github/workflows/commitTest.yml new file mode 100644 index 0000000..7916b71 --- /dev/null +++ b/.github/workflows/commitTest.yml @@ -0,0 +1,24 @@ +name: Build Mod + +on: [push, pull_request] + +jobs: + buildJar: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up PATH + run: | + echo "${ANDROID_HOME}/build-tools/34.0.0" >> $GITHUB_PATH + - name: Set up JDK 17 + uses: actions/setup-java@v1 + with: + java-version: 17 + - name: Build mod jar + run: ./gradlew deploy + - name: Upload built jar file + uses: actions/upload-artifact@v2 + with: + name: ${{ github.event.repository.name }} + path: build/libs/${{ github.event.repository.name }}.jar diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..435a4bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,157 @@ +logs/ +/core/assets/mindustry-saves/ +/core/assets/mindustry-maps/ +/core/assets/bundles/output/ +/core/assets/.gifimages/ +/deploy/ +/desktop/packr-out/ +/desktop/packr-export/ +/desktop/mindustry-saves/ +/desktop/mindustry-maps/ +/desktop/gifexport/ +/core/lib/ +/ios/assets/ +/core/assets-raw/sprites/generated/ +/core/assets-raw/sprites_out/ +/annotations/build/ +/annotations/out/ +/net/build/ +/tools/build/ +/tests/build/ +/server/build/ +/test_files/ +/annotations/build/ +/desktop-sdl/build/ +desktop-sdl/build/ +/android/assets/mindustry-maps/ +/android/assets/mindustry-saves/ +/core/assets/gifexport/ +/core/assets/version.properties +/core/assets/locales +/ios/src/io/anuke/mindustry/gen/ +/core/src/io/anuke/mindustry/gen/ +ios/robovm.properties +packr-out/ +config/ +*.gif + +version.properties + +.attach_* +## Java + +*.class +*.war +*.ear +hs_err_pid* +crash-report-* +replay_pid* + +## Robovm +/ios/robovm-build/ + +## GWT +/html/war/ +/html/gwt-unitCache/ +.apt_generated/ +.gwt/ +gwt-unitCache/ +www-test/ +.gwt-tmp/ + +## Android Studio and Intellij and Android in general +/android/libs/armeabi/ +/android/libs/armeabi-v7a/ +/android/libs/arm64-v8a/ +/android/libs/x86/ +/android/libs/x86_64/ +/android/gen/ +.idea/ +*.ipr +*.iws +*.iml +/android/out/ +com_crashlytics_export_strings.xml + +## Eclipse + +.classpath +.project +.metadata/ +/android/bin/ +/core/bin/ +/desktop/bin/ +/html/bin/ +/ios/bin/ +/ios-moe/bin/ +*.tmp +*.bak +*.swp +*~.nib +.settings/ +.loadpath +.externalToolBuilders/ +*.launch + +## NetBeans + +/nbproject/private/ +/android/nbproject/private/ +/core/nbproject/private/ +/desktop/nbproject/private/ +/html/nbproject/private/ +/ios/nbproject/private/ +/ios-moe/nbproject/private/ + +/build/ +/android/build/ +/core/build/ +/desktop/build/ +/html/build/ +/ios/build/ +/ios-moe/build/ + +/nbbuild/ +/android/nbbuild/ +/core/nbbuild/ +/desktop/nbbuild/ +/html/nbbuild/ +/ios/nbbuild/ +/ios-moe/nbbuild/ + +/dist/ +/android/dist/ +/core/dist/ +/desktop/dist/ +/html/dist/ +/ios/dist/ +/ios-moe/dist/ + +/nbdist/ +/android/nbdist/ +/core/nbdist/ +/desktop/nbdist/ +/html/nbdist/ +/ios/nbdist/ +/ios-moe/nbdist/ + +nbactions.xml +nb-configuration.xml + +## Gradle + +/local.properties +.gradle/ +gradle-app.setting +/build/ +/android/build/ +/core/build/ +/desktop/build/ +/html/build/ +/ios/build/ +/ios-moe/build/ + +## OS Specific +.DS_Store +Thumbs.db +android/libs/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..c75215c --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Mindustry Java Mod Template +A Java Mindustry mod template that works on Android and PC. The Kotlin version of this mod can be seen [here](https://github.com/Anuken/MindustryKotlinModTemplate). + +## Building for Desktop Testing + +1. Install JDK **17**. +2. Run `gradlew jar` [1]. +3. 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: +1. 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. +2. 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. +3. 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. + +## Building Locally + +Building locally takes more time to set up, but shouldn't be a problem if you've done Android development before. +1. Download the Android SDK, unzip it and set the `ANDROID_HOME` environment variable to its location. +2. Make sure you have API level 30 installed, as well as any recent version of build tools (e.g. 30.0.1) +3. Add a build-tools folder to your PATH. For example, if you have `30.0.1` installed, that would be `$ANDROID_HOME/build-tools/30.0.1`. +4. Run `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. + +## 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. + +--- + +*[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.* diff --git a/assets/sprites/frog.png b/assets/sprites/frog.png new file mode 100644 index 0000000..52e6c0e Binary files /dev/null and b/assets/sprites/frog.png differ diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..d74e75d --- /dev/null +++ b/build.gradle @@ -0,0 +1,100 @@ +apply plugin: "java" + +version '1.0' + +sourceSets.main.java.srcDirs = ["src"] + +repositories{ + mavenCentral() + maven{ url "https://raw.githubusercontent.com/Zelaux/MindustryRepo/master/repository" } + maven{ url 'https://www.jitpack.io' } +} + +java{ + targetCompatibility = 8 + sourceCompatibility = JavaVersion.VERSION_17 +} + +ext{ + //the build number that this mod is made for + mindustryVersion = 'v146' + jabelVersion = "93fde537c7" + //windows sucks + isWindows = System.getProperty("os.name").toLowerCase().contains("windows") + sdkRoot = System.getenv("ANDROID_HOME") ?: System.getenv("ANDROID_SDK_ROOT") +} + +//java 8 backwards compatibility flag +allprojects{ + tasks.withType(JavaCompile){ + options.compilerArgs.addAll(['--release', '8']) + } +} + +dependencies{ + compileOnly "com.github.Anuken.Arc:arc-core:$mindustryVersion" + compileOnly "com.github.Anuken.Mindustry:core:$mindustryVersion" + + annotationProcessor "com.github.Anuken:jabel:$jabelVersion" +} + +//force arc version +configurations.all{ + resolutionStrategy.eachDependency { details -> + if(details.requested.group == 'com.github.Anuken.Arc'){ + details.useVersion "$mindustryVersion" + } + } +} + +task jarAndroid{ + dependsOn "jar" + + doLast{ + if(!sdkRoot || !new File(sdkRoot).exists()) throw new GradleException("No valid Android SDK found. Ensure that ANDROID_HOME is set to your Android SDK directory."); + + def platformRoot = new File("$sdkRoot/platforms/").listFiles().sort().reverse().find{ f -> new File(f, "android.jar").exists()} + + if(!platformRoot) throw new GradleException("No android.jar found. Ensure that you have an Android platform installed.") + + //collect dependencies needed for desugaring + def dependencies = (configurations.compileClasspath.asList() + configurations.runtimeClasspath.asList() + [new File(platformRoot, "android.jar")]).collect{ "--classpath $it.path" }.join(" ") + + def d8 = isWindows ? "d8.bat" : "d8" + + //dex and desugar files - this requires d8 in your PATH + "$d8 $dependencies --min-api 14 --output ${project.archivesBaseName}Android.jar ${project.archivesBaseName}Desktop.jar" + .execute(null, new File("$buildDir/libs")).waitForProcessOutput(System.out, System.err) + } +} + +jar{ + archiveFileName = "${base.archivesBaseName}Desktop.jar" + + from{ + configurations.runtimeClasspath.collect{ it.isDirectory() ? it : zipTree(it) } + } + + from(rootDir){ + include "mod.hjson" + } + + from("assets/"){ + include "**" + } +} + +task deploy(type: Jar){ + dependsOn jarAndroid + dependsOn jar + archiveFileName = "${base.archivesBaseName}.jar" + + from{ [zipTree("$buildDir/libs/${project.archivesBaseName}Desktop.jar"), zipTree("$buildDir/libs/${project.archivesBaseName}Android.jar")] } + + doLast{ + delete{ + delete "$buildDir/libs/${project.archivesBaseName}Desktop.jar" + delete "$buildDir/libs/${project.archivesBaseName}Android.jar" + } + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..2bcb316 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,13 @@ +org.gradle.jvmargs=--illegal-access=permit \ +--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.jvm=ALL-UNNAMED \ +--add-exports=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED \ +--add-exports=java.base/sun.reflect.annotation=ALL-UNNAMED \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..94336fc Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..84a0b92 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..cccdd3d --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..f955316 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/mod.hjson b/mod.hjson new file mode 100644 index 0000000..5b5614c --- /dev/null +++ b/mod.hjson @@ -0,0 +1,23 @@ +#the mod name as displayed in-game +displayName: "Java Mod Template" + +#the internal name of your mod +name: "example-java-mod" + +#your name +author: "You" + +#the fully qualified main class of the mod +main: "example.ExampleJavaMod" + +#the mod description as seen in the mod dialog +description: "A Mindustry Java mod template." + +#the mod version +version: 1.0 + +#the minimum game build required to run this mod +minGameVersion: 145 + +#this is a java mod +java: true diff --git a/src/example/ExampleJavaMod.java b/src/example/ExampleJavaMod.java new file mode 100644 index 0000000..e500367 --- /dev/null +++ b/src/example/ExampleJavaMod.java @@ -0,0 +1,36 @@ +package example; + +import arc.*; +import arc.util.*; +import mindustry.*; +import mindustry.content.*; +import mindustry.game.EventType.*; +import mindustry.gen.*; +import mindustry.mod.*; +import mindustry.ui.dialogs.*; + +public class ExampleJavaMod extends Mod{ + + public ExampleJavaMod(){ + Log.info("Loaded ExampleJavaMod constructor."); + + //listen for game load event + Events.on(ClientLoadEvent.class, e -> { + //show dialog upon startup + Time.runTask(10f, () -> { + BaseDialog dialog = new BaseDialog("frog"); + dialog.cont.add("behold").row(); + //mod sprites are prefixed with the mod name (this mod is called 'example-java-mod' in its config) + dialog.cont.image(Core.atlas.find("example-java-mod-frog")).pad(20f).row(); + dialog.cont.button("I see", dialog::hide).size(100f, 50f); + dialog.show(); + }); + }); + } + + @Override + public void loadContent(){ + Log.info("Loading some example content."); + } + +}