Xenia Canary Game Patches

This repository contains game patches for Xenia Canary.

Installing/Updating

All patches

1. Delete patches folder if present.
2. Download the zip file.
3. Extract the patches folder to the proper location:

   	Location
   Default	Documents\xenia
   portable.txt (Portable mode)	Same directory as xenia.exe

4. Continue to enabling patches.

Individual patch(es)

1. Open the patch file on GitHub.
2. Right click Raw, and click Save Page As.
3. Place the file into the patches folder.
4. Continue to enabling patches.

Enabling patches

apply_patches must be set to true in the Xenia Canary config!

To enable patches, open the .patch.toml file that corresponds to your game in a text editor (Notepad, VSCode, VSCodium, Notepad++, etc.), and change is_enabled from false to true.

Note about aspect ratio patches

present_letterbox must be changed from true to false!

These patches do not increase resolution!

While most aspect ratio patches are 21:9 (3440/1440), they can be changed to other aspect ratios as well;

1. Divide your monitor's resolution width by height (i.e. 3440/1440)
2. Convert the result to hex.
3. Change the value to 0x######## replacing ######## with the hex value.

Troubleshooting

If the above sections didn't help, you can try the following:

1. Make sure you followed Enabling patches.
2. Try deleting all of your patches and updating them.
3. Try commenting out the hash of the patch like so:

   # Add # before hash
   hash = "################"
   # like this
   #hash = "################"
   

   This isn't guaranteed to work, and may cause crashes.
   Hashes are used to verify the correct version of a game is being patched, and this bypasses it.

Contributing

• When submitting a patch, create a Pull Request for a file to be added to /patches.
• New file must be named Title ID - Game Title.patch.toml
  For example, a patch file for Blue Dragon must be called 4D5307DF - Blue Dragon.patch.toml.
• If the game you are submitting a patch for already has a file, then add to that file.
• New file must contain the module hash, which can be automatically or manually obtained.
  • For games with multiple executables or discs, it can have multiple hashes, but they must be commented out like so: https://github.com/xenia-canary/game-patches/blob/95f51801048dc6e95675581e3fcf8fcdfc3e5544/patches/454108D8%20-%20Army%20of%20Two%20The%2040th%20Day.patch.toml#L3-L6
• File must contain an empty line at the end.

Prerequisites

• Cheat Engine
• Ghidra
  • Ghidra XEX Loader
• IDA Pro
  • IDA 7 XEX Loader
  • IDA 6 XEX Loader
• Text editors:
  • Visual Studio Code
  • VSCodium
  • Notepad++
• Recommended but optional:
  • ESLint TOML plugin
    • See Editor Integrations
  • Visual Studio Code/VSCodium extensions:
    • Even Better TOML

Setting up Cheat Engine

Memory Breakpoints can be set in Cheat Engine or MSVC with emit_source_annotations = true. This will give annotations in disassembly.

• Cheat Engine 7.2+ includes Big Endian types, but they must be enabled;
  • Click Edit > Options > Extra Custom Types and check all of them.
• Go to Scan Settings and enable MEM_MAPPED.
• Change 'Memory Scan Options' to:

  	All
  Start	100000000
  Stop	200000000

  • This may change depending on the programs you have running.
  • Once you find a value you can attach Cheat Engine's debugger to see what reads/writes to that address.
    This will show an xex address when a breakpoint is hit, although there is currently no way to set a breakpoint on execution within the Xenia Debugger.

Creating patch

To make things easier, it's recommended to put Xenia Canary in the directory that contains /patches and run it with portable.txt.

1. Set log_level to at least 2 (default) in the Xenia Canary config; See How to use for location.
2. Run the game at least once.
3. Close Xenia.
4. Obtain module hash/title ID/title name;
   • Search Ctrl+F for Module hash: in xenia.log
     You should see something like:

     i> ######## Module \Device\Cdrom0\default.xex:
     Module Hash: ################