modify New Super Mario Bros. Wii, Mario Kart Wii, Kirby's Adventure Wii, Tokyo Mirage Sessions #FE, Pokemon X/Y, Pokemon OR/AS, Bravely Second
Go to file
Christopher Roy Bratusek 2441e6c37e Merge remote-tracking branch 'github/master' 2023-10-01 10:51:40 +02:00
data add new custom karts for Mario Kart Wii 2016-08-21 21:04:22 +02:00
database Merge remote-tracking branch 'github/master' 2023-10-01 10:51:40 +02:00
debian debian/changelog 2016-09-27 18:11:13 +02:00
override update overrides, too 2017-01-10 17:38:01 +01:00
patches updated ESBW patch (dmm) 2013-07-14 18:40:25 +02:00
scripts Merge pull request #3 from alberic89/alpine 2023-08-19 19:18:52 +02:00
tools update wit to 2.40a, update szs to 1.53a 2017-01-07 19:45:36 +01:00
ChangeLog update ChangeLog 2019-08-14 21:28:00 +02:00
LICENSE LICENSE README 2013-06-13 20:15:28 +02:00
Makefile string changes 2016-08-27 21:18:10 +02:00
README README 2016-08-29 16:43:27 +02:00
README.CMD_OPTS minor help message re-organization 2016-08-19 10:39:09 +02:00
README.EXIT_CODES docs 2016-07-26 23:18:34 +02:00
README.GAMEIDS update README.GAMEIDS 2019-08-14 21:25:01 +02:00
README.RC update README files 2016-08-02 22:21:17 +02:00
README.STATUS_CODES rewrite downloader function 2016-08-07 19:17:31 +02:00
patchimage.sh Add Newer Alpine Dream 2023-08-19 12:53:01 +02:00

README

Based on DMMs and Wiimms excellent work, I've created a flexible patchscript
for GNU/Linux. Patchimage is a script that allows to patch riivoluton, ips
or xdelta patches into wbfs or iso images of legal game dumps, ROMs or dumped
cpk files.

features include:
 - downloading riivolution files or patches
 - downloading soundtracks (if available)
 - downloading custom banners for Wii games (if available)
 - downloading covers for Wii games (if available)
 - automatic storing of patched games into desired destination (see README.RC)
 - automatic patching of Wii games, 3DS games, Wii U games
 - replacing characters, fonts and items in Mario Kart Wii
 - replacing characters in New Super Mario Bros. Wii
 - replacing first players Kirby in Kirby's Adventure Wii
 - patch Nintendo WFC compatible games to use WiimmFi server

NOTE: don't fiddle around with sub-folders in riivolution-files, the script uses
files as "unzip" creates them. No need to modify anything.

You need the original games to do this legally, if you don't own the original,
you can't blame me. patchimage is 100% legal, as it does not contain any
propritary contents, nor is able to grab them.

patchimage supports the following base games:
	* New Super Mario Bros. Wii
	* Kirby's Adventure Wii
	* Mario Kart Wii
	* Tokyo Mirage Sessions #FE
	* Pokemon X
	* Pokemon Y
	* Pokemon Omega Ruby
	* Pokemon Alpha Sapphire
	* Bravely Second

More information:
	* supported game modifcations, search paths and expecte file names
		see README.GAMEIDS
	* supported commandline flags
		see README.CMD_OPTS
	* configuration file example
		see README.RC
	* status code while processing
		see README.STATUS_CODES
	* exit codes (for debugging)
		see README.EXIT_CODES

Example usages:

	Newer Super Mario Bros. Wii
	$ patchimage --game=NewerSMBW --iso=/home/test/SMNP01.iso --download

	Zelda: Parallel Worlds
	$ patchimage --game=ParallelWorlds --rom=/home/test/ALTTP.smc --download

	Toyko Mirage Sessions #FE Restoration
	$ patchimage --game=TMSFE --xdelta=/home/test/xdelta/ \
		--cpk=/home/test/ASEP01/content/Pack/

	Newer Super Mario Bros. Wii and Cannon Super Mario Bros. in one go:
	$ patchimage --game="NewerSMB Cannon" --iso=/home/test/SMNP01.iso --download

	All Mods of New Super Mario Bros. Wii:
	$ patchimage --game=NSMB_ALL --iso=/home/test/SMNP01.iso --download

License: GNU GPLv3
Extra Licenses:
> applyppf3	as-is
> xml patches	as-is
> other tools	GNU GPL v2 / GNU GPL v3