Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bates64/star-rod-mod
Template repository for making Paper Mario mods with Star Rod Classic without committing any Nintendo assets
https://github.com/bates64/star-rod-mod
paper-mario-64 star-rod
Last synced: 14 days ago
JSON representation
Template repository for making Paper Mario mods with Star Rod Classic without committing any Nintendo assets
- Host: GitHub
- URL: https://github.com/bates64/star-rod-mod
- Owner: bates64
- Created: 2020-08-22T18:03:35.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-03T09:42:21.000Z (7 months ago)
- Last Synced: 2024-10-22T07:03:24.198Z (2 months ago)
- Topics: paper-mario-64, star-rod
- Homepage:
- Size: 83 KB
- Stars: 2
- Watchers: 1
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Star Rod Classic Mod template
This is a base repository for making Paper Mario mods using Star Rod Classic ([download](https://starhaven.dev/)).
### Getting started
* [Fork this repository](https://github.com/bates64/star-rod-mod/fork)
* Clone your new repository
* Open the Star Rod Mod Manager
* Set the _Mod Folder_ to the directory you cloned into
* _Copy Assets to Mod_
* Create your mod as usual, e.g. make a change and compile the mod.
### Images, sprites, and audio
Some assets, such as those in the `image` and `sprite` folders, do not use the `patch`/`src` system. By default, this template **ignores all changes to assets within these folders**, because you shouldn't be including content from the original ROM in any public Git repository. You'll need to explicitly include assets you change by editing the relevant `.gitignore` file.
For example, assume I have changed `image/bg/kpa_bg.png`. In order to ask Git to include this change, I add the following line to `image/.gitignore`:
```diff
# Original game data
*.png
*.mis
*.iis
*.mtl
*.txa
+
+ # Modified assets
+ !/bg/kpa_bg.png
```
Git will now track changes to this file now and in the future.
(Alternatively, I could have used `git add --force image/bg/kpa_bg.png`. This will work, but [it may cause issues](https://stackoverflow.com/a/42723384) in the future if the file is deleted, for whatever reason, but then recreated later. Git will have forgotten that it should be tracking the file!)
This process applies to any assets in the `audio`, `image`, and `sprite` folders.
### Extra patches
This repository has other branches each implementing extra behaviours not found in a default Star Rod mod, such as those fixing bugs or implementing new game mechanics. You can view these [here](https://github.com/bates64/star-rod-mod/pulls?q=is%3Apr+is%3Aopen+label%3Aextra). To merge a patch into your mod, run the following commands. Some patches might require extra setup.
```
$ git remote add upstream https://github.com/bates64/star-rod-mod
$ git fetch upstream
$ git merge upstream/NAME_OF_PATCH
```
Extra patches will not merge ("refusing to merge unrelated histories") if you [generated](https://github.com/nanaian/star-rod-mod/generate), rather than forked, this repository. In this case, manually cherry-pick the commits you want.