https://github.com/umrninside/simplemmu4mindustry

Combine memory cells together in an easy way.
https://github.com/umrninside/simplemmu4mindustry

Last synced: about 2 months ago
JSON representation

Combine memory cells together in an easy way.

• Host: GitHub
• URL: https://github.com/umrninside/simplemmu4mindustry
• Owner: UMRnInside
• Created: 2023-03-25T09:22:09.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-25T09:22:11.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T02:07:59.139Z (2 months ago)
• Language: Kotlin
• Size: 94.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Mindustry Kotlin Mod Template

A Kotlin Mindustry mod that works on Android and PC. This is equivalent to the [Java](https://github.com/Anuken/ExampleJavaMod) version, except in Kotlin.

## Building for Desktop Testing

1. Install JDK 14. If you don't know how, look it up. If you already have any version of the JDK >= 8, that works as well. 

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. 

--- 

*[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.*