diff --git a/README b/README new file mode 100644 index 0000000..f834780 --- /dev/null +++ b/README @@ -0,0 +1,78 @@ +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... + +patchimage allows choosing a custom GAMEID, aswell as downloading +riivolution-files, patches and soundtrack (if available). + +NOTE: don't fiddle around with sub-folders in riivolution-files, the +script uses files as "unzip" creates them. No need to modify whatever. + +... 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. + +Supported Games +* Newer SMBW (riivolution) +* Cannon SMBW (riivolution) +* Another SMBW (riivolution) +* Newer Summer Sun (riivolution) +* Newer Holiday Special (riivolution) +* Epic Super Bower World (riivolution) +* The Legend of Zelda: Parallel Worlds (ips) + +Default Searchpaths: + + 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) + +Parameters +--game={NewerSMB;NewerSummerSun;AnotherSMBW;HolidaySpecial;ParallelWorlds} +specify game to create (if none is provided, the script will ask you) + +--iso/--rom=/home/test/ +specify path to the original ISO/ROM + +--riivolution/--patch= +specify path to Riivolution/Patch files + +--version=EURv1,EURv2,USAv1,USAv2,JPNv1 +specify your game version (for Wii games, if auto-detection fails) + +--customdid=SMNP02 +specify a custom ID to use for the game + +--sharesave +let modified game share savegame with original game + +--download +download riivolution/patchfiles + +--soundtrack +download soundtrack (if available) and exit + +--banner= +specify a custom banner to use + +--download-banner +download a custom banner (if available) + +--clean +cleanup working directory from anything (also riivolution patches) + +Examples: + +NewerSMBW: +$ patchimage --game=NewerSMBW --iso=/home/test/SMNP01.iso --download + +Zelda: Parallel Worlds +$ patchimage --game=ParallelWorlds --rom=/home/test/ALTTP.smc --download + +License: GNU GPLv3 +Extra Licenses: + +> wit GNU GPL v2 +> uips GNU GPL v2 +> applyppf3 as-is +> xml-patchfiles as-is