Starsector Mod Template

This is a basic Github template to create a working Starsector mod. Under the hood it uses a Gradle automation tool to fetch dependencies and compile source code.

Usage

1. Have Java SDK installed, anything 7 or above will work
2. Pick a mod name (can have spaces, e.g. "My Starsector Mod") and mod identifier (cannot have spaces, only A-z, "mymod", try to make it unique across mod-verse)
3. Click "Use this template", use your mod identifier as "Repository name"
4. Run ./gradlew build or gradlew.bat build (depending on your operating system) - you will get "empty" jar (empty because there is no code yet)

Adding scripts

To start creating your mod:

1. Create a folder in src/main/java with the mod identifier name (e.g. src/main/java/mymod).
2. (Optional) Add your mod plugin, recommended would be src/main/java/mymod/MymodPlugin.java - this file "lives" in package mymod; and initializes your mod.
3. Write remaining code.
4. Build, package, release.

Building

Already covered in usage, just run ./gradlew build or gradlew.bat build.

Packaging

1. Create src/main/resources/mod_info.json with correct structure.
2. (optional) Create additional content in src/main/resources:
   1. data and graphics folders (if any) with their content,
   2. any other files you want to bundle.
3. Run ./gradle release (mod_info.json's version will be used)

Releasing

1. Click "Create a release" (either from main page of your repository or from "Releases" tab).
2. Name a tag, add title, and add description (optional, usually a list of changes made in this version).
3. Add zip file you created in Packaging section and click "Publish release".