Star Rod Mod template

This is a base repository for making Paper Mario mods using Star Rod (download here).

Getting started

• Fork this repository
• 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:

  # 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 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. To merge a patch into your mod, run the following commands. Some patches might require extra setup.

$ git remote add upstream https://github.com/nanaian/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, rather than forked, this repository. In this case, manually cherry-pick the commits you want.