this repo has no description
Merge pull request #1 from bates64/main
Add readme
+37
-1
+37
-1
README.md
+37
-1
README.md
···
1
1
# Star Rod
2
2
3
-
A suite of tools for editing assets from the Paper Mario 64 decomp.
3
+
[][releases]
4
+
[][download]
5
+
6
+
[![#star-rod channel in the Star Haven Discord][discord-badge]][discord]
7
+
8
+
A suite of tools for editing assets from the [Paper Mario (2000) decompilation](https://github.com/pmret/papermario).
9
+
10
+
Star Rod supports Windows, Linux, and macOS.
11
+
12
+
**[Download Star Rod][download]**
13
+
14
+
To get started with modding Paper Mario, see [docs.starhaven.dev](https://docs.starhaven.dev/tools/decomp/setup.html).
15
+
16
+
[discord]: https://discord.gg/star-haven
17
+
[discord-badge]: https://img.shields.io/discord/279322074412089344?color=%237289DA&logo=discord&logoColor=ffffff&label=%23star-rod
18
+
[papermario-repo]: https://github.com/pmret/papermario
19
+
[releases]: https://github.com/z64a/star-rodx/releases
20
+
[download]: https://github.com/z64a/star-rod/releases/latest
21
+
22
+
## Development
23
+
24
+
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.
25
+
26
+
To set up Star Rod for local development, follow these instructions:
27
+
28
+
1. Clone this repo, e.g. `gh repo clone z64a/star-rod`
29
+
2. Open it in [Visual Studio Code](https://code.visualstudio.com/): `code star-rod`
30
+
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.
31
+
4. Open the Explorer. Alternatively, press <kbd>Ctrl+Shift+E</kbd> / <kbd>⇧⌘E</kbd>.
32
+
5. Navigate to `src/main/java/app/StarRodMain.java`.
33
+
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)):
34
+
35
+
https://github.com/z64a/star-rod/blob/110ea7d6268f98a2bf565880572203bd066a9c1f/src/main/java/app/StarRodMain.java#L66
36
+
37
+
### Creating a ZIP locally
38
+
39
+
Use the _release_ - _createReleaseZip_ task in Gradle.