Merge remote-tracking branch 'github/master'

Add Newer Alpine Dream

ChangeLog

@@ -1,3 +1,361 @@
+v7.6.0 (----):
+::game updates:
+- Pokemon Rising Ruby: support version 2.1
+- Pokemon Sinking Sapphire: support version 2.1
+- support Wiimms Mario Kart Fun 2016-10
+- support Wiimms Mario Kart Fun 2017-05
+- support Wiimms Mario Kart Fun 2017-12
+- support Wiimms Mario Kart Fun 2018-03
+- support Wiimms Mario Kart Fun 2018-06
+- support Wiimms Mario Kart Fun 2018-09
+- support Wiimms Mario Kart Fun 2018-12
+- support Wiimms Mario Kart Fun 2019-03
+- support Wiimms Mario Kart Fun 2019-06
+- support Newer Super Luigi Wii: Dark Moon (@lordofpeace)
+
+::tools updates:
+- update WIT to 2.40a
+- update SZS to 1.53a
+
+::misc. changes:
+- update title database
+
+v7.5.0 (20160927):
+::game additions:
+- add support for Super Mario Bros. Frozen Editon
+
+::game updates:
+- Pokemon Rising Ruby: support version 2.0
+- Pokemon Sinking Sapphire: support version 2.0
+
+::misc. changes:
+- fix ID6 for NSMBW3: The Final Levels in README.GAMEIDS
+- other minor changes
+
+v7.4.0 (20160903):
+::Tokyo Mirage Sessions #FE Restoration Patcher
+- use 'Restoration' instead of 'Uncensored' as Name
+- more failsafe build-directory name
+- add support for downloading xdelta files with --download
+- check whether files have already been downloaded and use those
+- for xdelta patches and original cpk files, now check whether every single
+  file exists, rather than just one of them
+- for cpk file path support both the top level directory of the dump as well
+  as the sub level directory which holds the cpk files, read: when your dump
+  is in /home/test/TMSFE you were previously required to set the cpk path to
+  /home/test/TMSFE/vol/content/Pack now using /home/test/TMSFE will work, too,
+  as the script will look for the sub directory vol/content/Pack on it's own
+
+::game updates:
+- update Cliff Super Mario Bros. Wii to version 1.1.1
+- update Revised Super Mario Bros. Wii to version 1.1
+- update The Legend of Yoshi to version 2016-08-31
+
+::misc. changes:
+- use 'wget -nv' instead of 'wget -q'
+  - except for cover downloader
+
+v7.3.1.1 (20160829):
+::bug fixes
+- fixed brocken nsmb-helper script
+
+v7.3.1 (20160828):
+::bug fixes
+- fixed that --iso, --rom, --patch, --xdelta, --cpk and --riivolution command
+  line flags failed when relative paths were given (regression from 7.2.2)
+- fixed that temporary files were kept when downloads failed, causing required
+  user-input for wget when trying again
+- fixed that --cpk and --xdelta command line flags never actually checked wether
+  the given directory does exist, before trying to patch the game [the game
+  patcher does, too, but it should fail immediately upon wrong user-input]
+- remove build directory before trying to build a game, not afterwards, so that
+  in case a build failed in batch-mode, the next one can be tried without issues
+- fixed that character mods were not applicable to Cliff Super Mario Bros. Wii
+
+::misc. changes:
+- drop support for Awesomer Super Luigi Mini (broken and offline)
+- update Cliff Super Mario Bros. to version 1.1
+
+v7.3.0 (20160827):
+::internal changes:
+- modularize common.sh
+- supply megadl (32 and 64 bit)
+
+::downloader changes:
+- changed download links to Mediafire so that they can automatically be
+  downloaded using wget, this makes Cliff Super Mario Bros., Ghostly Super
+  Mario Boos Wii, MLG Super Mario Bros. Wii, Pokemon Neo X, Pokemon Neo Y
+  and Pokemon Red Ruby auto-downloadable
+- changed download links to Sendspace so that they can automatically be
+  downloaded using wget, this makes Challenging Super Mario Bros. Wii:
+  Virtual Special auto-downloadable
+- include megadl a tool that can download files from Mega using commandline,
+  this makes Pokemon Delta Emerald, Pokemon Rutile Ruby, Pokemon Star Sapphire
+  and Bravely Second Uncensored auto-downloadable
+
+::misc. changes:
+- update Cliff Super Mario Bros. to version 1.0.5
+
+v7.2.2 (20160823):
+::bug fixes
+- fix PATCHIMAGE_3DS_DIR setup when no ${HOME}/.patchimage.rc exists
+- fix PATCHIMAGE_ROM_DIR setup when no ${HOME}/.patchimage.rc exists
+- fixed that the script expected wrong parameter --show-downloadlink
+  instead of correct --show-download
+- fix error messages or required user-input during batch-build by
+  creating a separate build directory, then create the mod and before
+  the next build is done that build directory is removed and re-created
+  - when ${PWD} is writable that will be ${PWD}/patchimage_build, else
+    it will be ${HOME}/patchimage_build
+
+::misc. changes
+- use 'read -er' instead of 'read -r' so that during user-input readline
+  features like path-completion can be used.
+- in game information fix link to Pokemon Star Sapphire Thread
+- update Cliff Super Mario Bros. to version 1.0.4
+
+v7.2.1 (20160822):
+::bug fixes
+- fix ID for Kirby's Adventure Wii and Mario Kart Wii for US versions
+
+v7.2.0 (20160822):
+::internal changes
+- functions for applying IPS, PPF and BPS patches now check for patch zip files
+  in ${PWD} and ${PACHIMAGE_RIIVOLUTION_DIR}, just like all other functions and
+  unpack them, if found
+- functions for applying IPS, PPF and BPS patches now look in ${PWD} and
+  ${PATCHIMAGE_RIIVOLUTION_DIR} for patch files
+- functions for applying IPS, PPF and BPS patches thus only fail when they
+  neither find a zip archive containing the patch, or the bare patch file
+- HANS patcher now supports applying DELTA patches
+- split out messages into message.sh
+- automatic downloading is not possible from SendSpace, update downloader
+  function to inform user to manually download from there
+
+::bug fixes
+- Pokemon Star Sapphire was accidently called Alpha Sapphire in the menu,
+  also had wrong Short ID
+- fixed that Opening Title for US version was applied to EU version in
+  MLG Super Mario Bros. Wii (fixes black screen on start)
+- fixed regression from version 7.1.0 that made it impossible to patch
+  US version of New Super Mario Bros. Wii because it was looking for wrong
+  ID SMNU01 instead of correct ID SMNE01
+- fixed black screen in Devil Mario Winter Special by not applying the custom
+  openingTitle.arc for PAL New Super Mario Bros. Wii
+- fixed black screen in Remixed Super Mario Bros. Wii by not applying the custom
+  openingTitle.arc for PAL and JAP New Super Mario Bros. Wii
+- fixed that the script did try to automatically download from mediafire instead
+  of informing user to manually download
+
+::command line parameters
+- add batch building short cuts for --game parameter:
+  * NSMB_ALL	build all NSMB Mods
+  * PKMN_ALL	build all Pokemon X, Y, Omega Ruby and Alpha Sapphire Mod
+  * PKMN_X	build all Pokemon X Mods
+  * PKMN_Y	build all Pokemon Y Mods
+  * PKMN_OR	build all Pokemon Omega Ruby Mods
+  * PKMN_AS	build all Pokemon Alpha Sapphire Mods
+- add --list-requirements ; show a detailed list of expected game images and
+  Riivolution or HANS archives or Patches required for building
+- add --list-requirements-nsmb, --list-requirements-mkwiimmfi,
+  --list-requirements-tokyo, --list-requirements-kirby,
+  --list-requirements-pokemon, --list-requirements-3ds,
+  --list-requirements-other, to show only requirements for mods of specific
+  base games
+- add --show-download ; only show download like for games choosen in menu or
+  given using --game parameter
+- added --list-games-nsmb, --list-games-mkwiimmfi, --list-games-tokyo,
+  --list-games-kirby, --list-games-pokemon, --list-games-3ds, --list-games-other
+  to show only mods for specific base games
+
+::misc. changes
+- new download link for The Legend of Yoshi
+- update to version 2016-05-28 of The Legend of Yoshi
+- update to version 1.02 of New Super Mario Bros. Wii - Other World
+
+::mod additions:
+- Mario Kart Wii Fonts:
+  - added Super Mario Font
+  - added Chalky Font
+  - added UmePlus Font
+  - sort files alphabetically in list
+- Mario Kart Wii Karts:
+  - update Sonic the Hedgehog on Foot to version 1.5
+  - add Black Mage on Wii Remote
+  - add White Mage on Wii Remote
+  - add Kirby on Wheelie
+  - add Nabbit on Flame Runner
+  - add Skull Kid on Bullet Bike
+  - add Super Sonic on Mach Bike
+  - add Wolf Link on Mach Bike
+
+::game additions
+
+:::New Super Mario Bros. Wii
+- add support for Cliff Super Mario Bros. Wii (SCL[PUJ]01)
+- add support for Challenging Super Mario Bros. Wii: Virtual Special (SMN[PUJ]ZC)
+
+:::Pokemon
+- add support for Pokemon Red Ruby
+  - supply HANS configuration files for Red Ruby
+- add support for Pokemon Delta Emerald (patch for Alpha Sapphire)
+  - supply HANS configuration files for Delta Emerald
+  - since the author of Delta Emerald is working on a patch for Omega Ruby
+    aswell, the game and created files are called "DeltaEmerald-AS"
+    [obviously they will be "DeltaEmerald-OR" for patched Omega Ruby]
+
+v7.1.0:
+::internal changes
+- rewrite downloader function
+- supply beat BPS patcher (32 and 64 bit)
+- add (yet unused) patching functions for PPF patches
+- add (yet unused) patching functions for BPS patches
+- code cleanup, remove duplicated code
+
+::bugfixes
+- fixup The Legend of Zelda - Parallel Worlds patcher
+- fixup --patch command line parameter
+
+::misc. changes
+- removed download link for Awesomer Super Luigi Mini (down)
+- new download link for RVLution Wii
+- new download link for Newer Falling Leaf
+- fix download link for Midi's Super Mario Wii
+- fix download link for Newer Apocalypse
+- New Super Mario Bros. Wii character mod: allow only restoring
+  original characters without further changes
+- update nsmbw.db
+
+::game additions
+
+:::New Super Mario Bros. Wii
+- add support for MLG Super Luigi Bros. Wii
+
+v7.0.0:
+::internal changes
+- add PATCHIMAGE_DIR new internal variable
+- add PATCHIMAGE_DATABASE_DIR new internal variable
+- add PATCHIMAGE_OVERRIDE_DIR new internal variable
+- add UNP_EXTRA_ARGS new internal variable
+- make check_input_rom a common.sh function, prevent duplicated code
+- shift around some paths
+- update database with New Super Mario Bros. Wii mods
+- code review and improvements
+- improved Debian GNU/Linux packaging
+- install pre-compiled tools to /usr/lib/ARCH/patchimage (FHS compliance)
+- improved --help message
+- add --list-games parameter (show buildable games)
+- --list-games and menu now show ID / Short Name and Full Name of all games
+- add --override-szs to override Wiims Mario Kart Fun wit and szs with
+  the ones supplied by patchimage. Use this if building Wiims Mario Kart Fun
+  fails due to incompatible library versions being installed.
+- add batch mode for generating more than one mod at once
+
+::bug fixes
+- several minor bugfixes and improvements
+- before creating any of the directories defined in ${HOME}/.patchimage.rc
+  check whether the parent directory is writeable, else fallback to ${HOME}
+- when setting destination directory for created files, check if they are
+  writeable, else fallback to ${HOME}
+- fix telling user path to Hans Files for all Pokemon game hacks
+- make the script more robust against directories with spaces in their names
+- use gdown.pl for drive.google.* download links
+- for download links on Mega tell user where to download manually
+- for download links on Mediafire tell user where to download manually
+- patchimage menu showed TMS1 as ID for Tokyo Mirage Sessions #FE restoration
+  patcher, while TMSFE was the actual (but wrong ID), thus TMS1 was reported
+  as unknown game / wrong user input. Now TMS1 works as expected.
+- archive name for Newer Super Mario Bros. Wii has changed
+
+::configuration file changes
+- new configuration variable PATCHIMAGE_3DS_DIR, global directory
+  where to look for unmodified 3DS ROM files
+- new configuration variable PATCHIMAGE_ROM_DIR, global directory
+  where to store your modified 3DS ROM files
+
+::documentation
+- update REAMDE
+- update README.RC
+- update README.STATUS_CODES
+- update README.GAMEIDS
+  - now includes game search paths
+  - now includes expected filenames
+
+::misc. changes
+- make check_input_rom search in both ${PATCHIMAGE_3DS_DIR} and ${PWD}
+- show full path for Hans Files for all games, instead of relative
+- only show path to Hans files if they exist
+- when downloading covers for Wii games fail, retry with the US cover
+- don't re-download covers that already exist
+- don't re-download soundtracks that already exist
+- for NSMBW character mods, Mario Kart Wii font, item and kart mods,
+  don't download the files from the interwebs, instead use files supplied
+  and installed with patchimage
+
+::game additions
+
+::::New Super Mario Bros. Wii
+- add support for Revised Super Mario Bros. Wii
+
+::::Pokemon
+- add support for Pokemon Eternal X
+  - choose between legal, rebalanced and insanity version
+  - for legal and rebalanced, choose whether to nerf first gym leader
+- add support for Pokemon Wilting Y
+  - choose between legal, rebalanced and insanity version
+  - for legal and rebalanced, choose whether to nerf first gym leader
+- add support for Pokemon Rising Ruby
+  - provide custom Hans banner and launcher
+- add support for Pokemon Sinking Sapphire
+  - provide custom Hans banner and launcher
+
+::::Other
+- add support for Bravely Second Uncensored
+  - fully supports both EUR and USA game version
+  - auto-detects provided game version in ${PWD} or ${PATCHIMAGE_3DS_DIR}
+  - provide Hans configuration
+
+::game changes and updates
+- update download link for Pokemon Rutile Ruby to v2.1
+- update download link for Pokemon Star Sapphire to v2.1
+
+v6.3.0:
+- supply ctrtool (32 and 64 bit versions)
+- supply 3dstool (32 and 64 bit versions)
+- add support for Pokemon Neo X
+  - choose between full and lite version
+  - provide custom HANS banner and launcher
+- add support for Pokemon Neo Y
+  - choose between full and lite version
+  - provide custom HANS banner and launcher
+- add support for Pokemon Rutile Ruby
+  - choose between legit, leveled and 679 build
+- add support for Pokemon Star Sapphire
+  - choose between legit, leveled and 679 build
+
+v6.2.2:
+- when running patchimage from git, use it's tools, scripts and stuff,
+  instead of system-wide (if) installed
+- simple progress [x/y] visualization for Tokyo Mirage Sessions #FE
+- minor internal changes
+
+v6.2.1:
+- support for MKWiimm 2016-07
+- update MKWiimm 2016-02 to v2
+- update Tokyo Mirage Sessions #FE patcher for version
+  0.9.4 of the patch
+- update szs to 1.52
+
+v6.2.0:
+- code improvements for MKWiimm
+- supply xdelta3 (32 and 64 bit versions)
+- supply titledumper (32 and 64 bit versions), for use with ddd
+- add support for Tokyo Mirage Sessions #FE US/EUR decensoring
+  - add --xdelta and --cpk parameters
+- use ${WIT} instead of wit when checking image region for
+  MKWiimm and Kirbys Adventure Wii
+- minor internal changes
+
 v6.1.0:
 - update szs to version 1.50a
 - update title database

LICENSE.EXTRA

@@ -1,2 +0,0 @@
-wit.*:		GNU GPL v2+
-patches/*:	as-is

Makefile

@@ -1,14 +1,31 @@
 all:
-	@echo "nothing to do"
+	@echo "nothing to do, use 'make install'"
 
 install:
 	mkdir -p $(DESTDIR)/usr/bin/
 	mkdir -p $(DESTDIR)/usr/share/patchimage/
-	cp -rv patches tools override script.d $(DESTDIR)/usr/share/patchimage/
+	cp -rv data database patches scripts $(DESTDIR)/usr/share/patchimage/
 	install -m755 patchimage.sh $(DESTDIR)/usr/bin/patchimage
+	if [ $(shell uname -m) = x86_64 ]; then \
+		mkdir -p $(DESTDIR)/usr/lib/x86_64-linux-gnu/patchimage/tools ; \
+		mkdir -p $(DESTDIR)/usr/lib/x86_64-linux-gnu/patchimage/override ; \
+		cp -rv tools/*.64 tools/unp tools/ucat tools/gdown.pl tools/ignore_3dstool.txt \
+			$(DESTDIR)/usr/lib/x86_64-linux-gnu/patchimage/tools ; \
+		cp -rv override/linux64 $(DESTDIR)/usr/lib/x86_64-linux-gnu/patchimage/override ; \
+	else	mkdir -p $(DESTDIR)/usr/lib/i386-linux-gnu/patchimage/tools ; \
+		mkdir -p $(DESTDIR)/usr/lib/i386-linux-gnu/patchimage/override ; \
+		cp -rv tools/*.32 tools/unp tools/ucat tools/gdown.pl tools/ignore_3dstool.txt \
+			$(DESTDIR)/usr/lib/i386-linux-gnu/patchimage/tools ; \
+		cp -rv override/linux32 $(DESTDIR)/usr/lib/i386-linux-gnu/patchimage/override ; \
+	fi
 
 uninstall:
 	rm -rf $(DESTDIR)/usr/share/patchimage
 	rm -f $(DESTDIR)/usr/bin/patchimage
+	if [ $(shell uname -m) = x86_64 ]; then \
+		rm -rf $(DESTDIR)/usr/lib/x86_64-linux-gnu/patchimage ; \
+	else	rm -rf $(DESTDIR)/usr/lib/i386-linux-gnu/patchimage ; \
+	fi
 
 clean:
+	@echo "nothing to"

README

@@ -1,47 +1,70 @@
-Based on DMMs and Wiimms excellent work, I've created a flexible
-patchscript for GNU/Linux. Additionally to riivolution patches, this
-one will also allow patching ROMs using ips/ppf patches. And more...
+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.
 
-patchimage allows choosing a custom GAMEID, aswell as downloading
-riivolution-files, patches and soundtrack (if available).
+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 whatever.
+NOTE: don't fiddle around with sub-folders in riivolution-files, the script uses
+files as "unzip" creates them. No need to modify anything.
 
-... Well, you need the original game 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.
+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.
 
-Starting with versions 4.90 and up, patchimage support Mario Kart Wiimm
-and Wimmfi (custom server for Mario Kart Wii and other games after the
-official server's shutdown).
+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 games: 		see file README.GAMEIDS
-	* supported commandline flags:	see file README.CMD_OPTS
-	* configuration file example:	see file README.RC
-	* status code while processing:	see file README.STATUS_CODES
-	* exit codes (for debugging):	see file README.EXIT_CODES
+	* 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
 
-Default searchpaths:
+Example usages:
 
-    ISO: BASE.iso / BASE.wbfs / GAMEID.iso / GAMEID.wbfs
-    Riivolution: Original name of the zip / unpacked folder
-    ROM: some mask matching the file (eg: "*[Ll]ink*[Pp]ast*smc" for Zelda: Parallel Worlds)
+	Newer Super Mario Bros. Wii
+	$ patchimage --game=NewerSMBW --iso=/home/test/SMNP01.iso --download
 
-Example usage:
+	Zelda: Parallel Worlds
+	$ patchimage --game=ParallelWorlds --rom=/home/test/ALTTP.smc --download
 
-NewerSMBW:
-$ patchimage --game=NewerSMBW --iso=/home/test/SMNP01.iso --download
+	Toyko Mirage Sessions #FE Restoration
+	$ patchimage --game=TMSFE --xdelta=/home/test/xdelta/ \
+		--cpk=/home/test/ASEP01/content/Pack/
 
-Zelda: Parallel Worlds
-$ patchimage --game=ParallelWorlds --rom=/home/test/ALTTP.smc --download
+	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:
-
-> wit GNU GPL v2
-> szs GNU GPL v2
-> uips GNU GPL v2
-> applyppf3 as-is
-> xml-patchfiles as-is
+> applyppf3	as-is
+> xml patches	as-is
+> other tools	GNU GPL v2 / GNU GPL v3

README.CMD_OPTS

@@ -1,39 +1,62 @@
-Parameters
---game={NewerSMB;NewerSummerSun;AnotherSMBW;HolidaySpecial;ParallelWorlds...}
-specify game to create (if none is provided, the script will ask you)
+*** General parameters ***
+--help						| show this message
+--game=<ID/Short Name>				| specify game you want to create
+--game=<ID1/Short Name1> <ID2/Short Name2>	| specify multiple games you want to create
+--show-download					| only show download link for required files
 
---iso/--rom=/home/test/<Image>
-specify path to the original ISO/ROM
+*** List games ***
+--list-games					| show possible options for --game
+--list-games-nsmb				| show possible New Super Mario Bros. Wii options for --game
+--list-games-mkwiimmfi				| show possible Mario Kart Wii / Wiimmfi options for --game
+--list-games-tokyo				| show possible Tokyo Mirage Sessions #FE options for --game
+--list-games-kirby				| show possible for Kirby's Adventure Wii options for --game
+--list-games-pokemon				| show possible Pokemon options for --game
+--list-games-3ds				| show possible 3DS options for --game
+--list-games-other				| show possible other options for --game
 
---riivolution/--patch=<Patch>
-specify path to Riivolution/Patch files
+*** List requirements ***
+--list-requirements				| show required image and patch files all games
+--list-requirements-nsmb			| show required image and patch files for New Super Mario Bros. Wii
+--list-requirements-mkwiimmfi			| show required image and patch files for Mario Kart Wii / Wiimmfi
+--list-requirements-tokyo			| show required files and patches for Tokyo Mirage Sessions #FE
+--list-requirements-kirby			| show required image and patch files for Kirby's Adventure Wii
+--list-requirements-pokemon			| show required image and patch files for Pokemon games
+--list-requirements-3ds				| show required image and patch files for other 3DS games
+--list-requirements-other			| show required image and patch files for other games
 
---version=EURv1,EURv2,USAv1,USAv2,JPNv1
-specify your game version (for NSMB, if auto-detection fails)
+*** Wii game parameters ***
+--iso=/home/test/RMCP01.iso			| specify path to Wii iso or wbfs image to use
+--riivolution=/home/test/MyMod.zip		| specify path to Wii Riivolution archive
+--version=EURv1,EURv2,USAv1,USAv2,JPNv1		| specify your game version (New Super Mario Bros. Wii)
+--customdid=SMNP02				| specify a custom ID to use for the modified Wii game
+--sharesave					| let modified Wii games share savegame with the original game
+--download					| download Riivolution or HANS patch archives (if possible)
+--soundtrack					| download soundtrack (if available)
+--only-soundtrack				| download soundtrack only (if available) and exit
+--covers					| download covers (if available)
+--only-covers=SMNP02				| download covers only (if available)
+--banner=<banner.bnr>				| use a custom banner (Riivolution games)
+--download-banner				| download a custom banner (if available)
+--override-szs					| override wit and szs in Wiimms Mario Kart Fun distributions
+						| [use this if the originals fail due to incompatible library versions]
 
---customdid=SMNP02
-specify a custom ID to use for the game
+*** 3DS game parameters ***
+--rom=/home/test/0004000000055e00.cxi		| specify path to 3DS ROM to use for building
+--hans=/home/test/MyModdedGame.zip		| specify path to 3DS HANS archive
 
---sharesave
-let modified game share savegame with original game
+*** Wii U game parameters ***
+--xdelta=/home/test/xdelta			| specify path to Tokyo Mirage Sessions #FE xdelta patches
+--cpk=/home/test/cpk				| specify path to original Tokyo Mirage Mirage Sessions #FE files
 
---download
-download riivolution/patchfiles
+*** Other game parameters ***
+--rom=/home/test/MyGame.rom			| specify path to ROM to use for building
+--patch=/home/test/MyModdedGame.ips		| specify path to IPS Patch file
 
---soundtrack
-download soundtrack (if available)
+*** Batch-Building shortcuts ***
+--game=NSMB_ALL					| build all mods of New Super Mario Bros. Wii
+--game=PKMN_ALL					| build all mods of Pokemon X, Y, Omega Ruby, Alpha Sapphire
+--game=PKMN_X					| build all mods of Pokemon X
+--game=PKMN_Y					| build all mods of Pokemon Y
+--game=PKMN_OR					| build all mods of Pokemon Omega Ruby
+--game=PKMN_AS					| build all mods of Pokemon Alpha Sapphire
 
---only-soundtrack
-only download soundtrack (if available) and exit
-
---covers
-download covers (if available)
-
---only-covers=SMNP02
-only download covers (if available) and exit
-
---banner=<banner>
-specify a custom banner to use
-
---download-banner
-download a custom banner (if available)

README.EXIT_CODES

@@ -13,7 +13,7 @@ right after the failure will you show the following:
 	33		custom banner specified from command line is not a .bnr file
 	39		custom game id specified from command line is not a 6 digit alphanumeric
 	45		error copying new game files
-	51		wit/ips/applyppf/szs caught an error processing files
+	51		wit/ips/applyppf/szs/xdelta3/3dstool/ctrtool caught an error processing files
 	57		wget caught an error while downloading
 	63		unp caught an error while unpacking a file
 	69		wiimmfi caught an error patching the image

README.GAMEIDS

@@ -2,38 +2,58 @@ GAMEIDS
 
 ### New Super Mario Bros. Wii ###
 
+>> searched paths:
+
+a) ${PWD}
+b) ${PATCHIMAGE_WBFS_DIR}
+
+>> expected filenames
+
+a) SMN?01.iso
+b) SMN?01.wbfs
+
+MRR?01		New Super Mario Bros. Wii Retro Remix
+SCL?01		Cliff Super Mario Bros. Wii
+SFR?01		Super Mario Bros. Frozen Editon
+SLB?01		MLG Super Luigi Bros. Wii
 SLF?01		NSMBW3: The Final Levels
-SMN?01		Original New Super Mario Bros. Wii
-SMN?02		?
+SMM?02		Super Mario: Mushroom Adventure PLUS - Winter Moon
 SMN?03		Newer Super Mario Bros. Wii
 SMN?04		Canon Super Mario Bros. Wii
 SMN?05		Another Super Mario Bros. Wii
 SMN?06		Newer Summer Sun
 SMN?07		Newer Holiday Special
 SMN?08		Epic Super Bowser World
-SMN?09		?
 SMN?10		Koopa Country
 SMN?11		New Super Mario Bros. 4
-SMN?12		Awesomer Super Luigi Mini
 SMN?31		New Super Mario Bros. Wii - Other World
 SMN?41		Devil Mario Winter Special
 SMN?60		Remixed Super Mario Bros. Wii
 SMN?65		Ghostly Super Ghost Boos. Wii
 SMN?66		The Legend of Yoshi
+SMN?69		Revised Super Mario Bros. Wii
 SMN?DU		DarkUmbra Super Mario Bros: Anniversary Edition
 SMN?FL		Newer: Falling Leaf
 SMN?MI		Midi's Super Mario Bros Wii - Just A Little Adventure
 SMN?RV		RVLution Wii (NewSMB Mod)
 SMN?YL		Luigi's Super Yoshi Bros.
 SMN?ZA		Newer Apocalypse
+SMN?ZC		Challenging Super Mario Bros. Wii: Virtual Special
 SMN?ZY		Super Mario Skyland
-SMM?02		Super Mario: Mushroom Adventure PLUS - Winter Moon
 SMV?01		Super Mario Vacation
-MRR?01		New Super Mario Bros. Wii Retro Remix
 
 ### Mario Kart Wii ###
 
-RMC?01		Original Mario Kart Wii
+>> searched paths:
+
+a) ${PWD}
+b) ${PATCHIMAGE_WBFS_DIR}
+
+>> expected filenames
+
+a) RMC?01.iso
+b) RMC?01.wbfs
+
 RMC?06		Wiimms MKW Fun 2010-12
 RMC?07		Wiimms MKW Retro 2011-02
 RMC?08		Wiimms MKW Fun 2011-03
@@ -57,8 +77,82 @@ RMC?25		Wiimms MKW-Fun 2014-04
 RMC?26		Wiimms MKW-Fun 2014-11
 RMC?27		Wiimms MKW-Fun 2015-03
 RMC?28		Wiimms MKW-Fun 2015-05
+RMC?29		Wiimms MKW-Fun 2015-08
+RMC?30		Wiimms MKW-Fun 2015-12
+RMC?31		Wiimms MKW-Fun 2016-02
+RMC?32		Wiimms MKW-Fun 2016-07
+RMC?33		Wiimms MKW-Fun 2016-10
+RMC?34		Wiimms MKW-Fun 2017-05
+RMC?35		Wiimms MKW-Fun 2017-12
+RMC?36		Wiimms MKW-Fun 2018-03
+RMC?37		Wiimms MKW-Fun 2018-06
+RMC?38		Wiimms MKW-Fun 2018-09
+RMC?39		Wiimms MKW-Fun 2018-12
+RMC?40		Wiimms MKW-Fun 2019-03
+RMC?41		Wiimms MKW-Fun 2019-06
 
 ### Kirby's Adventure Wii ###
 
-SUK?01		Kirby's Adventure Wii (only exchanging first
-		player's character is supported)
+>> searched paths:
+
+a) ${PWD}
+b) ${PATCHIMAGE_WBFS_DIR}
+
+>> expected filenames
+
+a) SUK?01.iso
+b) SUK?01.wbfs
+
+SUK?01		Kirby's Adventure Wii
+		* exchange first player's character
+
+### Pokemon ###
+
+>> searched paths:
+
+a) ${PWD}
+b) ${PATCHIMAGE_3DS_DIR}
+
+>> expected filenames
+
+a) GAMEID.cxi
+
+0004000000055D00	Pokemon X
+			* Pokemon Neo X
+			* Pokemon Eternal X
+0004000000055E00	Pokemon Y
+			* Pokemon Neo Y
+			* Pokemon Wilting Y
+000400000011C400	Pokemon Omega Ruby
+			* Pokemon Rutile Ruby
+			* Pokemon Rising Ruby
+000400000011C500	Pokemon Alpha Sapphire
+			* Pokemon Star Sapphire
+			* Pokemon Sinking Sapphire
+			* Pokemon Delta Emerald (Alpha Saphhire)
+
+### Bravely ###
+
+>> searched paths:
+
+a) ${PWD}
+b) ${PATCHIMAGE_3DS_DIR}
+
+>> expected filenames
+
+a) GAMEID.cxi
+
+000400000017BB00	Bravely Second
+			* De-Censoring the game
+
+### Toyko Mirage Sessions #FE ###
+
+>> searched paths:
+
+none (specified by user)
+
+>> expected filenames
+
+none (specified by user)
+
+ASE?01		De-Censoring the game

README.RC

@@ -18,6 +18,12 @@ PATCHIMAGE_WBFS_DIR=/media/chris/WiiHDDX/wbfs
 # global directory your wbfs files will be saved to
 PATCHIMAGE_GAME_DIR=/media/chris/WiiHDDX/wbfs
 
+# global directory where your rom files will be saved to
+PATCHIMAGE_3DS_DIR=/media/sde1/
+
+# global directory where your rom files will be saved to
+PATCHIMAGE_ROM_DIR=/media/sde1/hans/
+
 # global directory soundtracks will be saved to
 PATCHIMAGE_AUDIO_DIR=${HOME}/Music
 

README.STATUS_CODES

@@ -1,19 +1,23 @@
 While the script executes you will see some status codes, below you will find the meaning:
 
 	phase		code		meaning
-	*** 1)		0		neither BASE.iso nor BASE.wbfs found
-			1		BASE.iso found in ${PWD}
-			2		BASE.wbfs found in ${PWD}
 
-	*** 2)		0		no <GAMEID>.iso/.wbfs found (or required if *** 1) exited with 1 or 2)
+	*** 1)		0		no <GAMEID>.iso/.wbfs found (or required if *** 1) exited with 1 or 2)
 			1		<GAMEID>.iso found in ${PWD}
 			2		<GAMEID>.wbfs found in ${PWD}
 			3		<GAMEID>.iso found in ${PATCHIMAGE_WBFS_DIR}
-			4		<GAMEID>.iso found in ${PATCHIMAGE_WBFS_DIR}
+			4		<GAMEID>.wbfs found in ${PATCHIMAGE_WBFS_DIR}
+			5		no <MASK>.cxi found (3DS ROM)
+			6		<MASK>.cxi found in ${PWD}
+			7		<MASK>.cxi found in ${PATCHIMAGE_3DS_DIR}
+			8		xdelta/cpk found based on interactive user-input
+			9		xdelta/cpk found based on non-interactive user-input
 
-	*** 3)		0		no riivolution files found unpacked in ${PWD}
+	*** 2)		0		no riivolution files found unpacked in ${PWD}
 			1		riivolution files/archive not found in ${PWD}
 			2		riivolution archive found in ${PWD}
 			3		riivolution archive found in ${PATCHIMAGE_RIIVOLUTION_DIR}
 			4		patchimage was told to download riivolution archive, but no link is available
-			5		patchimage is downloading riivolution archive
+			5		patchimage is downloading riivolution archive
+			6		patchimage was told to download riivolution archive, but manual download is required
+					[for websites like mediafire, mega that don't work (well) with wget]

data/BravelySecondUncensored/3ds/hans/titles/0017BA00.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 0
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/BravelySecondUncensored/3ds/hans/titles/0017BB00.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 0
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/DeltaEmerald-AS/3ds/DeltaEmerald-AS.xml

@@ -0,0 +1,11 @@
+<shortcut>
+    <executable>/3ds/hans/hans.3dsx</executable>
+    <icon></icon>
+    <arg>-f/3ds/hans/titles/DeltaEmerald-AS.txt</arg>
+    <author>zakeblast</author>
+</shortcut>
+
+<targets selectable="0">
+    <title mediatype="1">000400000011C500</title>
+    <title mediatype="2">000400000011C500</title>
+</targets>

data/DeltaEmerald-AS/3ds/hans/titles/DeltaEmerald-AS.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/NeoX/3ds/NeoX.xml

@@ -0,0 +1,9 @@
+<shortcut>
+	<executable>/3ds/hans/hans.3dsx</executable>
+	<icon>/3ds/NeoX.smdh</icon>
+	<arg>-f/3ds/hans/titles/neox.txt</arg>
+</shortcut>
+<targets selectable="false">
+	<title mediatype="2">0004000000055D00</title>
+	<title mediatype="1">0004000000055D00</title>
+</targets>

data/NeoX/3ds/hans/titles/neox.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/NeoY/3ds/NeoY.xml

@@ -0,0 +1,9 @@
+<shortcut>
+	<executable>/3ds/hans/hans.3dsx</executable>
+	<icon>/3ds/NeoY.smdh</icon>
+	<arg>-f/3ds/hans/titles/neoy.txt</arg>
+</shortcut>
+<targets selectable="false">
+	<title mediatype="2">0004000000055E00</title>
+	<title mediatype="1">0004000000055E00</title>
+</targets>

data/NeoY/3ds/hans/titles/neoy.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/RedRuby/3ds/RedRuby.xml

@@ -0,0 +1,11 @@
+<shortcut>
+    <executable>/3ds/hans/hans.3dsx</executable>
+    <icon></icon>
+    <arg>-f/3ds/hans/titles/RedRuby.txt</arg>
+    <author>TheGreek Boy</author></author>
+</shortcut>
+
+<targets selectable="0">
+    <title mediatype="1">000400000011C400</title>
+    <title mediatype="2">000400000011C400</title>
+</targets>

data/RedRuby/3ds/hans/titles/RedRuby.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 1
+nim_checkupdate : 1

data/RisingRuby/3ds/RisingRuby.xml

@@ -0,0 +1,10 @@
+<shortcut>
+    <executable>/3ds/hans/hans.3dsx</executable>
+    <icon>/3ds/RisingRuby.smdh</icon>
+    <arg>-f/3ds/hans/titles/RisingRuby.txt</arg>  <author>Drayano</author>
+</shortcut>
+
+<targets selectable="0">
+    <title mediatype="1">000400000011C400</title>
+    <title mediatype="2">000400000011C400</title>
+</targets>

data/RisingRuby/3ds/hans/titles/RisingRuby.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 0
+nim_checkupdate : 1

data/SinkingSapphire/3ds/SinkingSapphire.xml

@@ -0,0 +1,10 @@
+<shortcut>
+    <executable>/3ds/hans/hans.3dsx</executable>
+    <icon>/3ds/SinkingSapphire.smdh</icon>
+    <arg>-f/3ds/hans/titles/SinkingSapphire.txt</arg>  <author>Drayano</author>
+</shortcut>
+
+<targets selectable="0">
+    <title mediatype="1">000400000011C500</title>
+    <title mediatype="2">000400000011C500</title>
+</targets>

data/SinkingSapphire/3ds/hans/titles/SinkingSapphire.txt

@@ -0,0 +1,6 @@
+region : -1
+language : -1
+clock : 1
+romfs : 0
+code : 0
+nim_checkupdate : 1