Skip to content

Commit

Permalink
Add Classic Mode & Tourney Mode c08+ Fix (+ updating all offsets with…
Browse files Browse the repository at this point in the history 
… Sig Scanning) (#505)

* Add Classic Mode Fix

* Fixes Tourney Mode c08+ Crash

* Fix Tourney Mode vec out_of_range crash

* Added sigscanning for most offsets in fixes.rs

* Revert `filesystem_info` and `res_service` offset

* Add `paramaters_cache` to offsets.rs
  • Loading branch information
@Coolsonickirby
Coolsonickirby committed Feb 24, 2023
1 parent 71764cb commit 26cb660
Show file tree
Hide file tree
Showing 3 changed files with 359 additions and 200 deletions.
141 changes: 76 additions & 65 deletions src/fixes.rs
View file
@@ -1,51 +1,71 @@
use skyline::{hook, hooks::InlineCtx, install_hooks, from_offset, patching::Patch};
use crate::offsets::*;
use crate::offsets;

// OFFSETS IN THIS FILE ARE CURRENTLY HARDCODED TO VERSION 13.0.1

// Patches to get Inkling c08+ working
fn install_inkling_patches(){
// All offsets related to Inkling stuff here
static INKLING_1_PATCH: usize = 0x35baed4;
static INKLING_2_PATCH: usize = 0x35baed8;
static CLEAR_INK_PATCH_OFFSET: usize = 0x35bb960;

#[skyline::hook(offset = CLEAR_INK_PATCH_OFFSET, inline)]
#[skyline::hook(offset = offsets::clear_ink_patch(), inline)]
unsafe fn clear_ink_patch(ctx: &mut InlineCtx) {
let res = (*ctx.registers[24].w.as_ref() as u32) % 8;
*ctx.registers[24].w.as_mut() = res;
}

// Inkling Patches here nop some branches so it can work with more than
// 8 players
Patch::in_text(INKLING_1_PATCH).nop().expect("Failed to patch inkling 1 cmp");
Patch::in_text(INKLING_2_PATCH).nop().expect("Failed to patch inkling 1 b.cs");
// Inkling Patches here nop some branches so it can work with more than c08+
Patch::in_text(offsets::inkling_patch()).nop().expect("Failed to patch inkling 1 cmp");
Patch::in_text(offsets::inkling_patch() + 4).nop().expect("Failed to patch inkling 1 b.cs");

install_hooks!(clear_ink_patch);
}

// Patches to get Aegis c08+ working + some issues reported with some other characters
/*
Patches for:
- Aegis c08+ working
- Some issues reported with some other characters
- Crashes in Classic Mode with colors greater than c08+
- Crashes in Tourney Mode when selecting a c08+ color
*/
fn install_added_color_patches(){

// Install inkling patches here since they're related to added color issues
install_inkling_patches();

// Offsets and Instructions that need to be patched in array so we don't repeat
// same code over and over.
// Format: (offset, instruction)
static SET_GLOBAL_COLOR_FOR_CLASSIC_MODE: usize = 0x23d94dc;

#[hook(offset = SET_GLOBAL_COLOR_FOR_CLASSIC_MODE, inline)]
pub unsafe fn set_global_color_for_classic_mode(ctx: &mut InlineCtx){
*(ctx.registers[9].w.as_mut()) = *(ctx.registers[9].w.as_ref()) % 8;
}

skyline::install_hook!(set_global_color_for_classic_mode);

/*
Offsets and Instructions that need to be patched in array so we don't repeat
same code with minor changes over and over.
Format: (offset, instruction)
*/
static ADDED_COLOR_PATCHES: &[(usize, u32)] = &[
(0x1834b0c, 0xF104027F), // cmp x19, #256 (Issue related to Aegis)
(0x18347bc, 0xF104027F), // cmp x19, #256 (Issue related to Aegis)
(0x1834b28, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x1834b28, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x1834ef8, 0xF10402FF), // cmp x23, #256 (Issue related to Aegis)
(0x183538c, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x183538c, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x1835ae4, 0xF104027F), // cmp x19, #256 (Issue related to Aegis)
(0x1835e00, 0xF104013F), // cmp x9, #256 (Issue related to Aegis)
(0x1a1c2f0, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x1a1c334, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x14de340, 0x7104013F), // cmp w9, #256 (Issue related to Terry)
(0x1835e00, 0xF104013F), // cmp x9, #256 (Issue related to Aegis)
(0x1a1c2f0, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)
(0x1a1c334, 0xF104011F), // cmp x8, #256 (Issue related to Aegis)

(0x14de340, 0x7104013F), // cmp w9, #256 (Issue related to Terry)
(0x14e1410, 0x710402FF), // cmp w23, #256 (Issue related to Terry)
(0x14e159c, 0x7104011F), // cmp w8, #256 (Issue related to Terry)
(0x14e159c, 0x7104011F), // cmp w8, #256 (Issue related to Terry)

(0x1a55584, 0x52800020), // mov w0, #1 (Issue related to Tourney Mode Crash)
(0x1a556b4, 0xF104011F), // cmp x8, #256 (Issue related to Tourney Mode Crash)
(0x1a54f74, 0x7104015F), // cmp w10, #256 (Issue related to Tourney Mode Crash)
(0x1a5500c, 0x7104001F), // cmp w0, #256 (Issue related to Tourney Mode Crash)
(0x1a55038, 0xF104001F), // cmp x0, #256 (Issue related to Tourney Mode Crash)
(0x1a54fa0, 0xF104001F), // cmp x0, #256 (Issue related to Tourney Mode Crash)
(0x1a54fd4, 0x7104017F), // cmp w11, #256 (Issue related to Tourney Mode Crash)
];

for entry in ADDED_COLOR_PATCHES {
Expand Down Expand Up @@ -73,53 +93,44 @@ fn install_lazy_loading_patches(){
(*(self.databases)).character
}
}

// All offsets related to lazy loading
static PARAMATERS_CACHE_OFFSET: usize = 0x532d730;
static LOAD_CHARA_1_FOR_ALL_COSTUMES_OFFSET: usize = 0x18465cc;
static LOAD_UI_FILE_OFFSET: usize = 0x323b290;
static GET_UI_CHARA_PATH_FROM_HASH_COLOR_AND_TYPE_OFFSET: usize = 0x3237820;
static GET_COLOR_NUM_FROM_HASH: usize = 0x32621a0;
static GET_ECHO_FROM_HASH: usize = 0x3261de0;
static LOAD_STOCK_ICON_FOR_PORTRAIT_MENU_OFFSET: usize = 0x19e784c;
static CSS_SET_SELECTED_CHARARACTER_UI_OFFSET: usize = 0x19fc790;
static CHARA_SELECT_SCENE_DESTRUCTOR_OFFSET: usize = 0x18467c0;

// Cache of variables we reuse later for loading UI + getting the character database
static mut PARAM_1: u64 = 0x0;
static mut PARAM_4: u64 = 0x0;
static mut PARAMATERS_CACHE: *const u64 = 0x0 as *const u64;

// This function is what's responsible for loading the UI File.
#[from_offset(LOAD_UI_FILE_OFFSET)]
#[from_offset(offsets::load_ui_file())]
pub fn load_ui_file(param_1: *const u64, ui_path_hash: *const u64, unk1: u64, unk2: u64);

// This function is the function that takes the ui_chara_hash, color_slot, and
// the type of UI to load and converts them to a hash40 that represents the path
// it needs to load
#[from_offset(GET_UI_CHARA_PATH_FROM_HASH_COLOR_AND_TYPE_OFFSET)]
/*
This function is the function that takes the ui_chara_hash, color_slot, and
the type of UI to load and converts them to a hash40 that represents the path
it needs to load
*/
#[from_offset(offsets::get_ui_chara_path_from_hash())]
pub fn get_ui_chara_path_from_hash_color_and_type(ui_chara_hash: u64, color_slot: u32, ui_type: u32) -> u64;

// This takes the character_database and the ui_chara_hash to get the color_num
#[from_offset(GET_COLOR_NUM_FROM_HASH)]
#[from_offset(offsets::get_color_num_from_hash())]
pub fn get_color_num_from_hash(character_database: u64, ui_chara_hash: u64) -> u8;

// This takes the character_database and the ui_chara_hash to get the chara's respective echo (for loading it at the same time)
#[from_offset(GET_ECHO_FROM_HASH)]
#[from_offset(offsets::get_echo_from_hash())]
pub fn get_ui_chara_echo(character_database: u64, ui_chara_hash: u64) -> u64;

#[hook(offset = LOAD_CHARA_1_FOR_ALL_COSTUMES_OFFSET, inline)]
#[hook(offset = offsets::load_chara_1_for_all_costumes(), inline)]
pub unsafe fn original_load_chara_1_ui_for_all_colors(ctx: &mut InlineCtx){
// Save the first and fourth paramater for reference when we load the
// file ourselves
// Save the first and fourth paramater for reference when we load the file ourselves
PARAM_1 = *ctx.registers[0].x.as_ref();
PARAM_4 = *ctx.registers[3].x.as_ref();
}

#[hook(offset = LOAD_STOCK_ICON_FOR_PORTRAIT_MENU_OFFSET, inline)]
#[hook(offset = offsets::load_stock_icon_for_portrait_menu(), inline)]
pub unsafe fn load_stock_icon_for_portrait_menu(ctx: &mut InlineCtx){
// If both of these params are valid, then most likely we're in the
// CharaSelectMenu, which means we should be pretty safe loading the CSPs
/*
If both of these params are valid, then most likely we're in the
CharaSelectMenu, which means we should be pretty safe loading the CSPs
*/
if PARAM_1 != 0 && PARAM_4 != 0 {
let ui_chara_hash = *ctx.registers[1].x.as_ref();
let color = *ctx.registers[2].w.as_ref();
Expand All @@ -129,18 +140,22 @@ fn install_lazy_loading_patches(){
}

pub unsafe fn load_chara_1_for_ui_chara_hash_and_num(ui_chara_hash: u64, color: u32){
// If we have the first and fourth param in our cache, then we're in the
// character select screen and can load the files manually
/*
If we have the first and fourth param in our cache, then we're in the
character select screen and can load the files manually
*/
if PARAM_1 != 0 && PARAM_4 != 0 {
// Get the color_num for smooth loading between different CSPs
// Get the character database for the color num function
let max_color: u32 = get_color_num_from_hash((*(*PARAMATERS_CACHE as *const ParametersCache)).get_chara_db() as u64, ui_chara_hash) as u32;
let max_color: u32 = get_color_num_from_hash((*(*(offsets::offset_to_addr(offsets::paramaters_cache()) as *const u64) as *const ParametersCache)).get_chara_db() as u64, ui_chara_hash) as u32;

let path = get_ui_chara_path_from_hash_color_and_type(ui_chara_hash, color, 1);
load_ui_file(PARAM_1 as *const u64, &path, 0, PARAM_4);

// Set next color to 0 if it's going to end up past the max, else just be
// the current color + 1
/*
Set next color to 0 if it's going to end up past the max, else just be
the current color + 1
*/
let next_color = {
let mut res = color + 1;
if res >= max_color {
Expand All @@ -149,8 +164,10 @@ fn install_lazy_loading_patches(){
res
};

// Set the previous color to max_color - 1 (so 8 - 1 = 7) if it's gonna be
// the u32::MAX (aka underflowed to max), else just be the current color - 1
/*
Set the previous color to max_color - 1 (so 8 - 1 = 7) if it's gonna be
the u32::MAX (aka underflowed to max), else just be the current color - 1
*/
let prev_color = {
let mut res = color - 1;
if res == u32::MAX {
Expand All @@ -167,7 +184,7 @@ fn install_lazy_loading_patches(){
}
}

#[hook(offset = CSS_SET_SELECTED_CHARARACTER_UI_OFFSET)]
#[hook(offset = offsets::css_set_selected_character_ui())]
pub unsafe fn css_set_selected_character_ui(
param_1: *const u64,
chara_hash_1: u64,
Expand All @@ -176,13 +193,13 @@ fn install_lazy_loading_patches(){
unk1: u32,
unk2: u32,
){
let echo = get_ui_chara_echo((*(*PARAMATERS_CACHE as *const ParametersCache)).get_chara_db() as u64, chara_hash_1);
let echo = get_ui_chara_echo((*(*(offsets::offset_to_addr(offsets::paramaters_cache()) as *const u64) as *const ParametersCache)).get_chara_db() as u64, chara_hash_1);
load_chara_1_for_ui_chara_hash_and_num(chara_hash_1, color);
load_chara_1_for_ui_chara_hash_and_num(echo, color);
call_original!(param_1, chara_hash_1, chara_hash_2, color, unk1, unk2);
}

#[hook(offset = CHARA_SELECT_SCENE_DESTRUCTOR_OFFSET)]
#[hook(offset = offsets::chara_select_scene_destructor())]
pub unsafe fn chara_select_scene_destructor(
param_1: u64,
){
Expand All @@ -192,22 +209,16 @@ fn install_lazy_loading_patches(){
call_original!(param_1);
}

// Gets the PARAMATERS_CACHE address so we can get the character database
// later
unsafe {
PARAMATERS_CACHE = offset_to_addr(PARAMATERS_CACHE_OFFSET) as *const u64;
}

// Prevent the game from loading all chara_1 colors at once for all characters
Patch::in_text(LOAD_CHARA_1_FOR_ALL_COSTUMES_OFFSET).nop().expect("Failed to patch chara_1 load");
Patch::in_text(offsets::load_chara_1_for_all_costumes()).nop().expect("Failed to patch chara_1 load");

// Install the hooks for everything necessary to properly load the chara_1s
install_hooks!(original_load_chara_1_ui_for_all_colors, css_set_selected_character_ui, load_stock_icon_for_portrait_menu, chara_select_scene_destructor);
}

// Patch to allow running uncompiled lua scripts
fn install_lua_magic_patch() {
Patch::in_text(lua_magic_check()).nop().expect("Failed to patch lua magic check cbnz");
Patch::in_text(offsets::lua_magic_check()).nop().expect("Failed to patch lua magic check cbnz");
}

pub fn install() {
Expand Down
10 changes: 5 additions & 5 deletions src/lib.rs
View file
Expand Up @@ -322,7 +322,7 @@ fn change_version_string(arg: u64, string: *const c_char) {
// #[skyline::from_offset(0x336d890)]
// pub fn stop_all_bgm();

#[skyline::hook(offset = offsets::eshop_show())]
#[skyline::hook(offset = offsets::eshop_button())]
fn show_eshop() {
// stop_all_bgm();
// let instance = (*(offsets::offset_to_addr(0x532d8d0) as *const u64));
Expand All @@ -331,7 +331,7 @@ fn show_eshop() {
// play_menu_bgm();
}

#[skyline::hook(offset = 0x3778bf4, inline)]
#[skyline::hook(offset = offsets::msbt_text(), inline)]
unsafe fn msbt_text(ctx: &mut InlineCtx) {
let msbt_label = skyline::from_c_str((ctx as *const InlineCtx as *const u8).add(0x100).add(224));

Expand Down Expand Up @@ -359,21 +359,21 @@ unsafe fn online_slot_spoof(ctx: &InlineCtx) {
}
}

#[skyline::hook(offset = 0x1bfa1e8, inline)]
#[skyline::hook(offset = offsets::skip_opening(), inline)]
unsafe fn skip_opening_cutscene(ctx: &mut InlineCtx) {
let data = ctx.registers[8].x.as_mut();
*data = 0;
}

// Change the next callback for the TitleSceneInfo::callbacks::Enter from "DisplayOpeningCutscene" to "HowToPlay"
#[skyline::hook(offset = 0x1864410, inline)]
#[skyline::hook(offset = offsets::title_scene_play_opening(), inline)]
unsafe fn title_scene_play_opening(ctx: &mut InlineCtx) {
let data = ctx.registers[9].x.as_mut();
*data = 1;
}

// Pretend the state for another state handler (OpeningCutsceneLayout?) is set to 5
#[skyline::hook(offset = 0x18644d0, inline)]
#[skyline::hook(offset = offsets::title_scene_how_to_play(), inline)]
unsafe fn title_scene_show_how_to_play_fake_state_index(ctx: &mut InlineCtx) {
let data = ctx.registers[8].x.as_mut();
*data = 5;
Expand Down

0 comments on commit 26cb660

Please sign in to comment.