patchimage

mirror of https://gitlab.com/Nanolx/patchimage.git synced 2024-12-28 18:11:50 +01:00

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 3f3894ddb0 code review, unification: - rename CXI to ROM (makes --rom command line flag work for 3DS ROMs, too) - rename CXI_MASK to ROM_MASK - rename WII_GENERIC to GENERIC - split functions in patchimage.sh - other minor changes		2016-08-06 19:46:07 +02:00
data	for NSMBW character mods, Mario Kart Wii font, item and kart mods,	2016-08-04 20:42:52 +02:00
database	- add PATCHIMAGE_DATABASE_DIR new internal variable	2016-08-04 20:28:09 +02:00
debian	install pre-compiled tools to /usr/lib/ARCH/patchimage/	2016-08-06 11:03:39 +02:00
override	update szs to 1.52	2016-07-03 13:09:59 +02:00
patches	updated ESBW patch (dmm)	2013-07-14 18:40:25 +02:00
scripts	code review, unification:	2016-08-06 19:46:07 +02:00
tools	fixup filename derp	2016-07-27 17:43:28 +02:00
ChangeLog	ChangeLog	2016-08-06 11:40:43 +02:00
LICENSE	LICENSE README	2013-06-13 20:15:28 +02:00
Makefile	install pre-compiled tools to /usr/lib/ARCH/patchimage/	2016-08-06 11:03:39 +02:00
patchimage.sh	code review, unification:	2016-08-06 19:46:07 +02:00
README	update README	2016-08-06 08:18:36 +02:00
README.CMD_OPTS	update README.CMD_OPTS	2016-07-01 22:09:24 +02:00
README.EXIT_CODES	docs	2016-07-26 23:18:34 +02:00
README.GAMEIDS	update docs, completely kill BASE.iso / BASE.wbfs stuff	2016-08-05 16:02:10 +02:00
README.RC	update README files	2016-08-02 22:21:17 +02:00
README.STATUS_CODES	update docs, completely kill BASE.iso / BASE.wbfs stuff	2016-08-05 16:02:10 +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/

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