Fork this repo, go to the Makefile and edit the variable in the CUSTOM VARIABLES header accordingly. Also double check the links at the bottom of this README file and change them when needed. Make sure you follow the guide to create a Dropbox App and upload the your personal backup ROM of your game. If you don't do this the Github Actions will not work!

This template and its documentation are using The Last Super game as an example. It is a funny open source game made to celebrate the 30th anniversary of the Super Nintendo, go check it out :)

After that you may remove this section from this README file.

This is a modification of the original game. As the game is protected by copyrights, this project cannot provide a copy of it for you to download but instead we provide a patch (.bps) file.

A patch is simply a file that contains all the differences between a game and its modified version. Applying a patch to an original game will result in the customized version.

In order to play it your must own the original game and also to have a backup of it in a ROM format, like .sfc. You will also need Flips a program that knows how to apply patches to original games.

Go to the latest release at the Releases page and download the patch file - it is the one finishing with .bps. Them use flips to apply the patch to your original backup ROM. Remember to create a copy of your ROM before applying anything!

With the modified game at hand you may play it using an emulator like RetroArch.

To build locally you will need Docker and make. On the root directory of this repo run

$ make prepare && make rom ORIGINAL_ROM=/path/to/your/orignal/backup/rom.sfc

which will create a playable ROM on ./build/release/. If you want instead to create a patch file, just run:

$ make prepare && make patch ORIGINAL_ROM=/path/to/your/orignal/backup/rom.sfc

again, a patch file will be created at ./build/release/.

Also if you are editing the source code it is probably a good idea to rebuild the ROM every time you change something. That can be achieved with

$ make prepare && make watch ORIGINAL_ROM=/path/to/your/orignal/backup/rom.sfc

Everything is automated by Github Actions, the only manual step is to edit the text of the release on Releases page. For more details please read the releasing manual.