README.md

Star Rod

A suite of tools for editing assets from the Paper Mario (2000) decompilation.

Star Rod supports Windows, Linux, and macOS.

Download Star Rod

To get started with modding Paper Mario, see docs.starhaven.dev.

Development

Star Rod is written in Java and uses the build tool Gradle. We recommend Visual Studio Code as your editor.

To set up Star Rod for local development, follow these instructions:

1. Clone this repo, e.g. gh repo clone z64a/star-rod
2. Open it in Visual Studio Code: code star-rod
3. At the bottom right hand corner, a prompt will appear to install the recommended Visual Studio Code extensions; click Yes. This will install the Java and Gradle editor extensions. You can see the Gradle elephant icon in the Activity Bar.
4. Open the Explorer. Alternatively, press Ctrl+Shift+E / ⇧⌘E.
5. Navigate to src/main/java/app/StarRodMain.java.
6. Click the "Run" button above the line declaring the main method (this type of button is called a CodeLens):

star-rod/src/main/java/app/StarRodMain.java

Line 66 in 110ea7d

public static void main(String[] args) throws InterruptedException

Creating a ZIP locally

Use the release - createReleaseZip task in Gradle.