# Star Rod
[][releases]
[][download]
[![#star-rod channel in the Star Haven Discord][discord-badge]][discord]
A suite of tools for editing assets from the [Paper Mario (2000) decompilation](https://github.com/pmret/papermario).
Star Rod supports Windows, Linux, and macOS.
**[Download Star Rod][download]**
To get started with modding Paper Mario, see [docs.starhaven.dev](https://docs.starhaven.dev/tools/decomp/setup.html).
[discord]: https://discord.gg/star-haven
[discord-badge]: https://img.shields.io/discord/279322074412089344?color=%237289DA&logo=discord&logoColor=ffffff&label=%23star-rod
[papermario-repo]: https://github.com/pmret/papermario
[releases]: https://github.com/z64a/star-rodx/releases
[download]: https://github.com/z64a/star-rod/releases/latest
## Development
Star Rod is written in [Java](https://dev.java/) and uses the build tool [Gradle](https://gradle.org/). We recommend [Visual Studio Code](https://code.visualstudio.com/) 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](https://code.visualstudio.com/): `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](https://code.visualstudio.com/blogs/2017/02/12/code-lens-roundup)):
https://github.com/z64a/star-rod/blob/110ea7d6268f98a2bf565880572203bd066a9c1f/src/main/java/app/StarRodMain.java#L66
### Creating a ZIP locally
Use the _release_ - _createReleaseZip_ task in Gradle.