Most games with 60 FPS patches have double-buffered vsync

Xenia Canary Game Patches

This repository contains game patches for Xenia Canary.

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

Prerequisites
- Latest Xenia Canary experimental.
  - Patches aren't supported on master or outdated versions of Xenia Canary.
Download this zip.
Go to where xenia_canary.exe is.
Delete patches folder if present (backup if needed).

Open game-patches.zip and extract patches in the same directory as xenia_canary.exe. The folder structure should look like this:

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

Continue to the section below.

How to use

Prerequisites
- Latest Xenia Canary experimental
  - Patches aren't supported on master or outdated versions of Xenia Canary.
- The right version of the game e.g. Title Update (TU).
- apply_patches set to true (default) in the Xenia Canary config.
Open the .patch.toml file that corresponds to your game in a text editor (Notepad, VSCode, VSCodium, Notepad++, etc.)

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##

becomes

[[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;
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.

Note about framerate patches

Framerates above 60 FPS require vsync to be changed from true to false in the Xenia Canary config.

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 a patch

Prerequisites

Cheat Engine
- See setting up Cheat Engine
Ghidra
- XEX Loader
IDA Pro
- IDA 7 XEX Loader
- IDA 6 XEX Loader
Text editors:
Recommended but optional:
- ESLint TOML plugin
  - See Editor Integrations
- Visual Studio Code/VSCodium extensions:
  - Even Better TOML
- To make things easier, put Xenia Canary in the directory that contains /patches and run it with portable.txt.

Guidelines

Patch must be named Title ID - Game Title.patch.toml and be in /patches.
For example, a patch file for Blue Dragon must be called 4D5307DF - Blue Dragon.patch.toml.
If you are making a patch for a game that already has a file, then add to it*
- Only exception being if you're patching a different module.
Submitting patches:
- No whitespace.
- Lowercase hex for address/value hex, uppercase for title ID/hash/media ID.

How to get the module hash and filename:

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.
Set log_level to at least 2 (default) in the Xenia Canary config; See How to use for location.
Run the game at least once.
Close Xenia Canary.
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: ################
```
- Patches can have multiple executables/hashes. Only leave the hash(es) you're using uncommented:
  
  game-patches/patches/454108D8 - Army of Two The 40th Day.patch.toml
  
  Lines 3 to 6 in 95f5180
  
  hash = [
  
  "7C5F016EA6A81E95" # default.xex
  
  # "2330F2A205951B81" # AO3MPGame-XeReleaseLTCG.xex
  
  ]

Patch types

`[[patch.*]]`	Info	Value (example)
`be8`	Hex, 1 byte	`0x00`
`be16`	Hex, 2 bytes	`0x0000`
`be32`	Hex, 4 bytes	`0x00000000`
`be64`	Hex, 8 bytes	`0x0000000000000000`
`array`	Hex, any size	`"0x##*"`
`f32`	Float, single	`1.0`
`f64`	Float, double	`1.0`
`string`	String, UTF-8	`"string"`
`u16string`	String, UTF-16	`"string"`

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): http://redump.org/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

Title ID	Serial	Name	Missing/bad info
4D5307D1	MS-2001	Project Gotham Racing 3	Missing: `media_id`
4D5307D2	MS-2002	Kameo: Elements of Power	Missing: `media_id`
4D5387E0	MS-34784	Kameo: Elements of Power (kiosk demo)	Missing: `media_id`
4D5387E9	MS-34793	Kameo: Elements of Power (demo)	Missing: `media_id`
4D530910	MS-2320	Forza Motorsport 4	Missing: `media_id`
58410B00	XA-2816	Dead Rising 2 Case West	Missing: `hash`
434307D4	CC-2004	Resident Evil 5	Missing: `hash` module filename
445007EA	DP-2026	Onechanbara	Missing: `hash` module filename `media_id`
454107D9	EA-2009	Need for Speed: Most Wanted (2005)	Missing: `media_id`
454107EC	EA-2028	Need for Speed: Carbon	Missing: `hash` module filename `media_id`
465307D6	FS-2006	Armored Core 4	Missing: `hash` `media_id`
545107FC	TQ-2044	Saints Row 2	Missing: `hash` module filename
545407DF	TT-2015	Rockstar Table Tennis	Missing: `hash` `media_id`
584108DB	XA-2267	A Kingdom for Keflings	Missing: `hash` module filename
584109FF	XA-2559	Plants vs. Zombies	Missing: `hash` module filename
4541087F	EA-2175	Skate 2	Missing: `media_id`
5553088C	US-2188	Far Cry 3	Missing: `hash` module filename Bad: `hash`
5841124F	XA-4687	Doritos Crash Course 2	Missing: `media_id`
41560904	AV-2308	Transformers: Rise of The Dark Spark	Missing: `hash`
43430830	CC-2096	Lost Planet 3	Missing: `hash`
43430841	CC-2113	Resident Evil	Missing: `hash` module filename
43430842	CC-2114	Resident Evil 0	Missing: `hash` module filename
45410806	EA-2054	Burnout Paradise (1.00)	Missing: `hash` `media_id`
45410806	EA-2054	Burnout Paradise (Screenshot)	Missing: `media_id`
45410914	EA-2324	Rock Band 3	Missing: `hash` module filename `media_id`
53450812	SE-2066	Sonic Unleashed (TU2)	Bad: `hash`
53450812	SE-2066	Sonic Unleashed	Missing: `media_id`
53510806	SQ-2054	Final Fantasy XIII-2	Missing: `hash` module filename `media_id`
57520802	WR-2050	Batman: Arkham City (TU6)	Missing: `hash` `hash` module filename `media_id`
57520802	WR-2050	Batman: Arkham City	Missing: `media_id`
57520828	WR-2088	Batman: Arkham Origins	Missing: `hash` `hash` module filename `media_id`
57520828	WR-2088	Batman: Arkham Origins (TU3)	Missing: `media_id`

Version	Game
5.0.1	ASURA'S WRATH
3.0.2	Kameo

	hash = [
	"7C5F016EA6A81E95" # default.xex
	# "2330F2A205951B81" # AO3MPGame-XeReleaseLTCG.xex
	]

	All
Start	`100000000`
Stop	`200000000`

xenia-canary / game-patches Goto Github PK

game-patches's Introduction

Xenia Canary Game Patches

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

Installing/Updating

How to use

Notes about aspect ratio patches

Note about framerate patches

Setting up Cheat Engine

Creating a patch

Prerequisites

Guidelines

How to get the module hash and filename:

Patch types

Example patch

game-patches's People

Contributors

Stargazers

Watchers

Forkers

game-patches's Issues

Example

Recommend Projects

Recommend Topics

Recommend Org

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