Xenia Canary Game Patches

Non-patch questions belong on the Xenia Discord server.

These are NOT actual games or Title Updates!
Read Xenia's Quickstart to get games.

Installing/Updating

1. Prerequisites

1. Download this 7z.
2. Go to where xenia_canary.exe is.
3. Delete patches folder if present (backup if needed).
4. Open game-patches.7z and extract patches in the same directory as xenia_canary.exe.

└─── Xenia Canary
        |  ...
        │  xenia_canary.exe
        |  ...
        └─── patches
                ...
                584111F7 - Minecraft (XBLA, TU0).patch.toml
                ...

1. Continue to the section below.

How to use

1. Prerequisites

1. Open the .patch.toml file that corresponds to your game in a text editor (Notepad, VSCode, VSCodium, Notepad++, etc.)
2. Change is_enabled from false to true. For example, to enable a 60 FPS patch:

[[patch]]
        name = "60 FPS"
        desc = "Description"
        author = "Author"
        is_enabled = false
[[patch.be8]]
            address = 0x########
            value = 0x##

[[patch]]
        name = "60 FPS"
        desc = "Description"
        author = "Author"
        is_enabled = true

[[patch.be8]]
            address = 0x########
            value = 0x##

If you see [Patches Applied] in the title bar then the patch(es) applied successfully.

Don't change the hash of existing patches. If your version of the game is different then the patch(es) need to be ported to that version.

Notes about aspect ratio patches

• present_letterbox must be changed from true to false!
• Aspect ratio 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 unless not specified or specified otherwise;

Note about framerate patches

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;

• Go to Scan Settings and enable MEM_MAPPED.
• Change 'Memory Scan Options' to:

• Once you find a value you can attach Cheat Engine's debugger to see what reads/writes to that address.

Creating a patch

Prerequisites

• Cheat Engine

• Ghidra

• IDA Pro

• Text editors:

• Recommended but optional:

Guidelines

• Patch must be named Title ID - Game Title.patch.toml and be in /patches.

• Submitting patches:

How to get the module hash and filename:

1. Don't change the hash of existing patches. If your version of the game is different then the patch(es) need to be ported to that version.
2. Set log_level to at least 2 (default) in the Xenia Canary config; See How to use for location.
3. Run the game at least once.
4. Close Xenia Canary.
5. Obtain module hash/title ID/title name;

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

Patch types

Example patch

title_name = "Game Title"
title_id = "1234ABCD" # AB-1234
hash = "################" # Module the hash applies to (i.e. default.xex)
          # Can be an array if applicable:
hash = [
  "################"     # See above
]
#media_id = "1234ABCD" # Optionally you can add a redump link; Disc (Region): https://redump.info/disc/1234
                       Can also be an array if applicable:
#media_id = [
 "1234ABCD"          # See above
#]
Title ID, hash, and media ID must be uppercase.
[[patch]]
  name = "Patch name"
  author = "Me"
  desc = "Patch description" # Description is optional
  is_enabled = false         # Must be false for PRs
[[patch.*]]
 For example, be8:
  [[patch.be8]]
    address = 0x82000000 # Tends to start with 0x8, always 4 bytes
    value = 0x00
 Address and value hex must be lowercase.
  string:
  [[patch.string]]
    address = 0x82000000 # Tends to start with 0x8, always 4 bytes
    value = "string"
End of file newline