Hacking patchimage (riivolution patcher for GNU/Linux)

[Excelsiior]

Thanks, gonna test the next days.

 

[Excelsiior]

v2.5 just released, see first post.

For everyone who speaks german, there's a full-fledged Wiiki-Article about Patchimage, I wrote. See: Wiiki/Patchimage

 

[Slimmmmmm]

This is great, off the top of my head NSMB, Mario Kart, SSBB, custom singing, and custom guitar/music games are about the only customs that are popular, or did I miss something ?

So the question is, do you plan to add support for the sing it/singstar customs, and the guitar hero customs ?
Are there other plans for the future ?

Just thought I'd ask some questions to keep the topic alive.
This is a life saver for some (eg faulty drive)

 

[Excelsiior]

I have not any plans for now, but it's not limited to NSMBW as such. So if there are PAL-compatible hacks (US-only is bad, because I don't own US-Discs) there's a good chance I'll add support for it. sooner or later.

 

[Excelsiior]

Version 3.0 is now available, see first post.

 

[killerone]

can someone make a batch file so i can play winter moon and NSMBW 3: The Final Levels iso , since i dont have linux

 

[flamepanther]

Would it be possible to support the Fatal Frame 4 translation patches?

can someone make a batch file so i can play winter moon and NSMBW 3: The Final Levels iso , since i dont have linux

Maybe support for that can be added to the NSMBW Mod ISO Builder? Otherwise, Linux is available for free, and you can run it from a VM if you don't care to fully install it.

 

[Excelsiior]

Would it be possible to support the Fatal Frame 4 translation patches?.

I don't own that game. But if you provide me a link, I may have a look.

 

[flamepanther]

I don't own that game. But if you provide me a link, I may have a look.

Will this help? Fatal Frame 4 Translation

 

[Excelsiior]

Will this help? Fatal Frame 4 Translation

I had not had the time to have a look, but I haven't forgotten about it.

Anyhow, version 3.1 is now available, changes:

v3.1:
- bugfix: for NSMBW3 on US games the language files weren't updated
- bugfix: for Super Mario: Mushroom Adventure PLUS - Winter Moon on US games the language files weren't updated
- bugfix: for Super Mario: Mushroom Adventure PLUS - Winter Moon on non-US games the supplied OpeningTitle does not work, so don' use it
- support for Super Mario Vacation

for more, see first post.

 

[Leo Alves]

Can you make this compatible for Project Zero 2 (Fatal Frame II) and Proyecto UNDUB (Undub Patch) ?

http://www.projectsae.es/project-zero-2-wii-edition/proyecto-undub.html

 

[flamepanther]

Can you make this compatible for Project Zero 2 (Fatal Frame II) and Proyecto UNDUB (Undub Patch) ?

http://www.projectsae.es/project-zero-2-wii-edition/proyecto-undub.html

He's already looking into the possibility of Fatal Frame 4. I don't think any undubs are likely though, since that would almost have to involve downloading files ripped directly from commercial games.

 

[Excelsiior]

Version 4.0 is now available.

highlights: no more black screen on NSMBW3 + WinterMoon, experimental support for Awesomer Super Luigi Mini, several bugfixes.

See first post.

 

[Excelsiior]

v4.97, the eighth beta of v5.0 is now available (haven't kept gbatemp up-to-date).

highlights:
- mario kart wiimm patcher support (download and patch stuff)
- mario kart wii item patcher (exchange some of the games items)
- wimmfi support for mario kart wii (patch mario kart wii to use custom server so online-races continue after WFC-shutdown)*
- wiimmfi support for any wii game (patch any wii game to use the custom server most games will NOT work out of the box, so provide dumps)*
- support for exchanging first player character in Kirby's Adventure Wii
- support for NSMB Mods: Super Mario Skyland, RVLution Wii
- updated WinterMoon download-link to latest version

* = Visit WHB for more information. about custom mario kart wii server

So here it is, complete ChangeLog since 4.0:

v4.97:
- changed IDs in the game selection menu (old A..Z for Wii, 1..9
  for ROMs / new <ID>1..<ID>..99 ; example: NSMB1, NSMB2, NSMB3)
- mkwiimm_items: support for exchanging items in Mario Kart Wii
  (your item choices are saved and can be re-used, so if you want
  to modifiy more than one Mario Kart you only have to choose the
  items once for all mods)
 
v4.96:
- wiimmfi/mkwiimm/kirbywii: minor improvements and fixups
- support RVLution Wii (a NewSMB Mod)
- update README.GAMEIDS
- update WinterMoon link to v1.2.3
- added gdown.pl (google-drive downloader) by circulosmeos
 
v4.95:
- fixed storing NewSMB mods into ${PATCHIMAGE_GAME_DIR}
- added support for exchanging first player's character
  in Kirby's Adventure Wii (using someone different than
  one of the different Kirbys may crash the game)
 
v4.94:
- wiimmfi generic: use correct version of wit
- wiimmfi mario kart: major code simplification and major speed-up
  (as we now symlink the old images rather than copying)
- mkwiimm support. Download and build any Mario Kart Wiimm distribution
  and patch it to use Wiimms custom server (thus patching process takes
  longer as there are two steps now). The old patchers will all work,
  because the outdated versions of the provided tools will be overriden.
- new patchimage.rc options:
    MKWIIMM_GAME_LANG    either de (german) or en (english)
        mkwiimm game language
    MKWIIMM_MSG_LANG    either de, de+ (german) or en, en+ (english)
        mkwiimm message language. de+ and en+ also change all
        other languages to german or english
    MKWIIMM_SHARE_SAVE    either 1=ja (yes) or 2=nein (no)
        whether to share save with the original game
  if you set them they will be applied for all mkwiimm patchers and no
  further user interactions with the wiimm patcher is needed.
- NOTE: error-handling for mkwiimm, wiimmfi generic and wiimmfi mario
  kart is not yet complete
 
v4.93:
- various fixups
- wiimmfi generic: show game titles next to id when showing available images
- wiimmfi generic: only offer those games to be patched that are wfc-enabled
  (according to gametdb)
- add support for Super Mario Skyland (SMN?ZY)
 
v4.92:
- wiimmfi mario kart: check if user-provided input is correct
- wiimmfi generic: add generic wiimmfi patcher (only one game at a time)
 
v4.91:
- update my mail address
- fixed downloading soundtracks
- when using wiimmfi stuff, ask whether to patch all or a specific image
- previously --soundtrack would download the soundtrack and exit. Now
  it does no longer exit.
- added --only-soundtrack (download soundtrack for selected game and exit)
- added --covers (download covers for selected game)
- added --only-covers (download covers for selected game and exit)
- added mkwiimm.db ("database" containing all RMC??? IDs for MKWiimm)
 
v4.90:
- support wiimmfi patcher. All RMC??? images in the current directory or
  all RMC??? images in ${PATCHIMAGE_WBFS_DIR} will be patched to use the
  new server. patchimage will download and prepare the wiimmfi-patcher,
  check the directory for RMC??? images (.iso and .wbfs), create a copy
  of your image for the patcher, let Wiimm's patcher do it's work, move
  the new image to ${PATCHIMAGE_GAME_DIR}.
  .
  Ensure both variables are set in ${HOME}/.patchimage.rc

>>> Download here

TODO
- update wit
- update szs
- exchange fonts in mario kart wii
- exchange drivers in mario kart wii
- ssbb project m
- fatal frame 4 (translation)

 

[Excelsiior]

Ouch... seems like I did not keep gbatemp up-to-date since 4.97 ... yesterday I already released 5.4.0. Either way, here's what's new (for 4.98 - 5.3.0 check ChangeLog file in the archive):

v5.4.0:
- fixed major bug creating MKWiimm: image was not saved to proper
destination directory (now everything's fine)
- update wit to version 2.31a
- update szs to version 1.39a
- add support for MKWiimm 2015-03
- add support for creating multiple MKWiimm at once
- add support for replacing karts in MKWiimm
The madness begins, feel free to test this out. downloaded
karts are prefixed mkwiimm_kart_ to avoid naming collision
with fonts and items (3-chars.szs naming-scheme)
.
Original files are backed-up in ${PATCHIMAGE_RIIVOLUTION_DIR}/ \
${GAME}_SZS/ - for example /home/chris/Hacks/RMCP27_SZS/ and
restored every time when you change your selection on the same
game.
.
Your choices are saved into ${HOME}/.patchimage.choice, if
you want to modify another MKWiimm with the same settings,
simply enter y when the script asks you whether you want to
apply your previous settings, else enter n for new choices.
.
No dummys were harmed during the making of this feature
- downloaded fonts for MKWiimm are now prefixed mkwiimm_font_
- downloaded items for MKWiimm are now prefixed mkwiimm_item_
- add support for SMN?41 (Devil Mario Winter Special)
- add support for SMN?31 (New Super Mario Bros. Wii - Other World)
- add MKWIIMM_OVERRIDE_SZS variable to patchimage.rc
If set to TRUE patchimage will override the supplied SZS tools
of the MKWiimm patcher with it's own version of the tools.
.
This is useful when the supplied ones don't work with your system's
libpng (usually this happens on non-recent Debian GNU/Linux).
.
If creating anything newer than RMCP26 (2015 versions) the tools will
be never overriden (for now, does not work yet).

TODO
- SSBB Project M
- Fatal Frame 4 (Fan Translation)

In regard to Fatal Frame 4, could someone who owns the game please extract it and post the complete directory structure? eg:

wit extract FATALFRAME4.wbfs workdir/
find workdir/ > FF4_filelist.txt

and then attach the file FF4_filelist.txt, so I can have a look at supporting it, thanks.

 

[Excelsiior]

In the GIT repository over at https://github.com/Nanolx/patchimage you'll now be able to pull a beta of version 6.0.0. This release will bring a few new features. The first ist: character replacement in NSMBW (original and mods).

Choose NSMB99 in the main menu. See: https://twitter.com/nanolx/status/620291636237594624 for screenshot.

Also to quote myself, if you want FF4 Fan-Translation support:

In regard to Fatal Frame 4, could someone who owns the game please extract it and post the complete directory structure? eg:

wit extract FATALFRAME4.wbfs workdir/
find workdir/ > FF4_filelist.txt

and then attach the file FF4_filelist.txt, so I can have a look at supporting it, thanks

SSB:Brawl Project M support planned aswell for version 6, stay tuned. If you know about more custom NSMBW characters, let me know.

 

[Excelsiior]

Version 6.3.0 is now available. In fact GBATemp-Thread missed versions 6.0.0 - 6.3.0.

Highlights
- bugfixes
- updates
- more NSMBW mods supported (Remixed Super Mario Bros. Wii, Ghostly Super Mario Bros. Wii)
- support replacing characters in NSMBW
- various fixes, updates and improvements regarding Wiimms Mario Kart Wii and WiimFi
- support for de-censoring Tokyo Mirage Sessions #FE
- support for patching 3DS ROMs (Pokemon Neo X/Y, Rutile Ruby, Star Sapphire)

See first post for links and stuff.

Full ChangeLog for versions 6.0.0 - 6.3.0:

v6.3.0:
- supply ctrtool (32 and 64 bit versions)
- supply 3dstool (32 and 64 bit versions)
- add support for Pokemon Neo X
- add support for Pokemon Neo Y
- add support for Pokemon Rutile Ruby
- add support for Pokemon Star Sapphire

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
- show "Enter ID (...)" message at the end of menu
- show "ID    Name" header/footer in menu
- show proper version number in --help
- support for new MKWiimm config.def variables ID >= 29
  - default set:
    - MSGLANG1 = -
    - MSGLANG2 = E
  - set from ~/.patchimage.rc
    - TRACKLANG = x,${MKWIIMM_MSG_LANG}
    - CTRENAME = ${MKWIIMM_CTRENAME}
    - REORDER = ${MKWIIMM_CTREORDER}
    - see README.RC for more infos
- support for MKWiimm 2015-08 (ID 29)
- support for MKWiimm 2015-12 (ID 30)
- support for MKWiimm 2016-02 (ID 31)
- support for The Legend of Yoshi (SMN?66)
- support for Remixed Super Mario Bros. Wii (SMN?60)
- support for Ghostly Super Mario Boos. Wii (SMN?65)
- update wit/wszst override for MKWiimm
  - if you can't build MKWiimm, set MKWIIMM_OVERRIDE_SZS=TRUE
    in ~/.patchimage.rc to use supplied tools, that the case
    on Debian GNU/Linux Stretch or Sid
- update link to Wiimmfi-Patcher (Generic)
  - unused Patchimage uses "wit cp --wiimmfi" instead
- update link to Wiimmfi-Patcher (Mario Kart Wii)
- update for Wiimmfi-Patcher script changes

v6.0.0:
- update szs to version 1.40a
- add support for MKWiimm 2015-05
- support for replacing characters in NSMBW

 

[Excelsiior]

Version 7.1.0 is now available.

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

 

[Excelsiior]

version 7.3.1 now available. See first post.

v7.3.1:
::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]

 

[zdv80]

Impressive tool... Thanks a lot!