Patching - choatix/Pokemon-Crystal-Item-Randomizer GitHub Wiki

Recommended tool: Lunar IPS / FLips

Justification: Providing patches is preferred to sending direct files.

Order of Events:

  1. Obtain a Vanilla 1.1 Crystal U rom.
  2. Use an IPS Tool to patch the VTo{Version}.ips onto the rom.
  3. Use ZX randomiser to randomise your rom.
  4. With the output of ZX, put the rom into item randomiser.
  5. Play with a GBC Emulator of your choice.

Naming scheme: Multiple patches will be released with each release. Note the {V} will refer to current version as a placeholder.

  • Vto{V} - Vanilla Crystal rom to latest version

  • {V-1}to{V} - Quick patch for active testers to last released version. ONLY works if using the exact version suggested, otherwise you need to manually update to each version, and it may be easier to use the prior version.

  • If you tested the previous version in any way, use the patch on the previous rom. This only occurs if you have the previous version as a simple shortcut.

  • Otherwise, obtain a Crystal vanilla rom and use this rom. DO NOT ask for this, but you should be able to locate it.

Patching Script:

To use the patching script, download the associated scripts, included in the release of the speedchoice version. You will also need to download FLips from here:

https://www.smwcentral.net/?p=section&a=details&id=11474

Flips is an IPS patch capable of working in the command line, allowing it be used in the script. For more information, or to look at FLIPS project, please go here: https://github.com/Alcaro/Flips

Include Flips, the .bat and the .ps1 file in the same folder. Copy in the IPS patch you plan to use, and include the gbc rom file you also plan to use. If there are multiple roms in the directory, it will detect which one is correct to be used. An error will be presented to the user if no rom matches. If you suspect this in in error, please file a bug report.

The correct patch will be detected and used, automatically applying the patch for you and producing a rom with the output of the version that it is. This will also confirm the rom value for you, presenting an error if it does not match the intended output.

UPR has been modified alongside this script to only allow the exact V8 Rom, so if the patching failed, UPR will not open the rom correctly.