Patchimage Wii

Patchimage
General
Author	nanolx
Type	PC Utilities
Version	7.5.0
License	GPL-3.0
Last Updated	2016/09/27
Links
Download
Website
Source

Patchimage is a riivolution patchscript for GNU/Linux. Based on DMMs and Wiimms excellent work, 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.

Note: You need the original games to do this legally. patchimage is 100% legal, as it does not contain any proprietary contents, nor is able to grab them.

Features

• Download riivolution files or patches.
• Download soundtracks (if available).
• Download custom banners for Wii games (if available).
• Download 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.
• Replace characters, fonts and items in Mario Kart Wii.
• Replace characters in New Super Mario Bros. Wii.
• Replace first players Kirby in Kirby's Adventure Wii.
• Patch Nintendo WFC compatible games to use WiimmFi server.

User guide

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

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.

See the included documentation for more information on specific features:

• Supported game modifcations, search paths and expecte file names - README.GAMEIDS
• Supported commandline flags - README.CMD_OPTS
• Configuration file example - README.RC
• Status code while processing - README.STATUS_CODES
• Exit codes (for debugging) - 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

Changelog

v7.5.0 2016/09/27

• 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 2016/09/03

• 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 2016/08/29/

• 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 2016/08/27

• 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 2016/08/23

• 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 2016/08/22

• Bug fixes:
  • Fix ID for Kirby's Adventure Wii and Mario Kart Wii for US versions.

v7.2.0 2016/08/22

• 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.
  • Qrchive 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.

External Links

• Official website - https://nanolx.org/wiihomebrew/patchimage/
• GitHub - https://github.com/Nanolx/patchimage
• Wii-Homebrew - https://forum.wii-homebrew.com/index.php/Thread/51845-ENG-Patchimage-5-1-0-available/?action=lastPost