Show update message if game is outdated

Author: zaksabeast

3gx/includes/memmem.h

@@ -0,0 +1,3 @@
+#include <3ds.h>
+
+void *memmem (const void *haystack, size_t haystack_len, const void *needle, size_t needle_len);

3gx/includes/title_info.h

@@ -3,3 +3,4 @@
 #include <3ds.h>
 
 u64 get_title_id();
+u64 get_remaster_version();

3gx/sources/main.c

@@ -9,24 +9,7 @@
 #include "pokereader.h"
 #include "title_info.h"
 #include "hid.h"
-
-typedef enum SupportedTitle
-{
-    GAME_X = 0x0004000000055D00,
-    GAME_Y = 0x0004000000055E00,
-    GAME_OR = 0x000400000011C400,
-    GAME_AS = 0x000400000011C500,
-    GAME_S = 0x0004000000164800,
-    GAME_M = 0x0004000000175E00,
-    GAME_US = 0x00040000001B5000,
-    GAME_UM = 0x00040000001B5100,
-    GAME_TRANSPORTER = 0x00040000000C9C00,
-    GAME_CRYSTAL_EN = 0x0004000000172800,
-    GAME_CRYSTAL_DE = 0x0004000000172B00,
-    GAME_CRYSTAL_FR = 0x0004000000172E00,
-    GAME_CRYSTAL_ES = 0x0004000000173100,
-    GAME_CRYSTAL_IT = 0x0004000000173400,
-} SupportedTitle;
+#include "memmem.h"
 
 static Handle thread;
 static Handle memLayoutChanged;
@@ -142,6 +125,15 @@ u8 HID_INPUT_MAP_PATCH[0x8] = {
     0x00, 0xf0, 0x1f, 0xe5, //     ldr        pc,[pc + 0x8]
 };
 
+u8 PRESENT_FRAMEBUFFER_BYTES[0X10] = {
+    0x28, 0x00, 0x8d, 0xe2, 0x00, 0x80, 0xa0, 0xe3, 0x01, 0x70, 0xa0, 0xe1, 0x00, 0x0e, 0x90, 0xe8,
+};
+
+u8 MAP_INPUT_BLOCK[] = {
+    0x01, 0x20, 0xa0, 0x13, 0x03, 0x20, 0xa0, 0x03, 0x01, 0x32, 0xa0, 0xe3, 0x1f, 0x00,
+    0x00, 0xef, 0xa0, 0x1f, 0xb0, 0xe1, 0x01, 0x10, 0xa0, 0x03, 0x18, 0x10, 0xc4, 0x05
+};
+
 extern char *fake_heap_start;
 extern char *fake_heap_end;
 extern u32 __ctru_heap;
@@ -181,76 +173,20 @@ void main(void)
     // Get memory layout changed event
     svcControlProcess(CUR_PROCESS_HANDLE, PROCESSOP_GET_ON_MEMORY_CHANGE_EVENT, (u32)&memLayoutChanged, 0);
 
-    u32 present_buffer_ptr = 0;
-    u32 get_screen_jump_inst = 0;
-    u32 map_input_memory_block = 0;
-
-    switch (get_title_id())
-    {
-    case GAME_X:
-        present_buffer_ptr = 0x149354;
-        get_screen_jump_inst = 0xeb006cca;
-        map_input_memory_block = 0x133dfc;
-        break;
-    case GAME_Y:
-        present_buffer_ptr = 0x149354;
-        get_screen_jump_inst = 0xeb006cca;
-        map_input_memory_block = 0x133dfc;
-        break;
-    case GAME_OR:
-        present_buffer_ptr = 0x148758;
-        get_screen_jump_inst = 0xeb0071d4;
-        map_input_memory_block = 0x1331e8;
-        break;
-    case GAME_AS:
-        present_buffer_ptr = 0x148758;
-        get_screen_jump_inst = 0xeb0071d4;
-        map_input_memory_block = 0x1331e8;
-        break;
-    case GAME_S:
-        present_buffer_ptr = 0x278540;
-        get_screen_jump_inst = 0xeb0003d3;
-        map_input_memory_block = 0x170eac;
-        break;
-    case GAME_M:
-        present_buffer_ptr = 0x278540;
-        get_screen_jump_inst = 0xeb0003d3;
-        map_input_memory_block = 0x170eac;
-        break;
-    case GAME_US:
-        present_buffer_ptr = 0x279bb4;
-        get_screen_jump_inst = 0xeb0003d3;
-        map_input_memory_block = 0x17234c;
-        break;
-    case GAME_UM:
-        present_buffer_ptr = 0x279bb4;
-        get_screen_jump_inst = 0xeb0003d3;
-        map_input_memory_block = 0x17234c;
-        break;
-    case GAME_TRANSPORTER:
-        present_buffer_ptr = 0x12b7ec;
-        get_screen_jump_inst = 0xeb02cbd4;
-        map_input_memory_block = 0x11f63c;
-        break;
-    case GAME_CRYSTAL_EN:
-    case GAME_CRYSTAL_DE:
-    case GAME_CRYSTAL_FR:
-    case GAME_CRYSTAL_ES:
-    case GAME_CRYSTAL_IT:
-        present_buffer_ptr = 0x14aa24;
-        get_screen_jump_inst = 0xeb00b512;
-        map_input_memory_block = 0x146a28;
-        break;
-    default:
-        return;
-    }
+    MemInfo info;
+    PageInfo out;
+    svcQueryMemory(&info, &out, 0x100000);
+ 
+    u32 present_buffer_ptr = (u32)memmem((u8*)info.base_addr, info.size, PRESENT_FRAMEBUFFER_BYTES, sizeof(PRESENT_FRAMEBUFFER_BYTES)) - 8;
+    u32 map_input_memory_block = (u32)memmem((u8*)info.base_addr, info.size, MAP_INPUT_BLOCK, sizeof(MAP_INPUT_BLOCK));
 
+    u32 get_screen_branch = *(u32 *)(present_buffer_ptr + 0x20) - 4;
     u32 *present_buffer_pa = (u32 *)PA_FROM_VA_PTR(present_buffer_ptr);
     memcpy(present_buffer_pa, DRAW_PATCH, 0x94);
     present_buffer_pa[0x4] = (u32)run_hook;
     // 7 instructions * 4 bytes per instruction
-    present_buffer_pa[0x5] = (u32)present_buffer_ptr + (0x7 * 0x4); // set return address
-    present_buffer_pa[0xc] = get_screen_jump_inst;                  // fix get_screen branch instruction
+    present_buffer_pa[0x5] = present_buffer_ptr + (0x7 * 0x4); // set return address
+    present_buffer_pa[0xc] = get_screen_branch;                // fix get_screen branch instruction
 
     u32 *map_input_memory_block_pa = (u32 *)PA_FROM_VA_PTR(map_input_memory_block);
     memcpy(map_input_memory_block_pa, HID_INPUT_MAP_PATCH, 0x8);

3gx/sources/memmem.c

@@ -0,0 +1,61 @@
+/* Copyright (C) 1991-2025 Free Software Foundation, Inc.
+   This file is part of the GNU C Library.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License along
+   with this program; if not, write to the Free Software Foundation,
+   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
+
+/*
+
+@deftypefn Supplemental void* memmem (const void *@var{haystack}, @
+  size_t @var{haystack_len} const void *@var{needle}, size_t @var{needle_len})
+
+Returns a pointer to the first occurrence of @var{needle} (length
+@var{needle_len}) in @var{haystack} (length @var{haystack_len}).
+Returns @code{NULL} if not found.
+
+@end deftypefn
+
+*/
+
+#include <stddef.h>
+#include <string.h>
+
+/* Return the first occurrence of NEEDLE in HAYSTACK.  */
+void *
+memmem (const void *haystack, size_t haystack_len, const void *needle,
+	size_t needle_len)
+{
+  const char *begin;
+  const char *const last_possible
+    = (const char *) haystack + haystack_len - needle_len;
+
+  if (needle_len == 0)
+    /* The first occurrence of the empty string is deemed to occur at
+       the beginning of the string.  */
+    return (void *) haystack;
+
+  /* Sanity check, otherwise the loop might search through the whole
+     memory.  */
+  if (__builtin_expect (haystack_len < needle_len, 0))
+    return NULL;
+
+  for (begin = (const char *) haystack; begin <= last_possible; ++begin)
+    if (begin[0] == ((const char *) needle)[0] &&
+	!memcmp ((const void *) &begin[1],
+		 (const void *) ((const char *) needle + 1),
+		 needle_len - 1))
+      return (void *) begin;
+
+  return NULL;
+}

3gx/sources/title_info.c

@@ -5,7 +5,6 @@ u64 g_program_id = 0;
 
 u64 get_title_id()
 {
-
   if (g_program_id == 0)
   {
     fsInit();
@@ -18,4 +17,20 @@ u64 get_title_id()
   }
 
   return g_program_id;
-}
+}
+
+u64 g_remaster_version = 0;
+
+u64 get_remaster_version() {
+  if (g_remaster_version == 0) {
+    fsInit();
+    u32 processId = 0;
+    svcGetProcessId(&processId, CUR_PROCESS_HANDLE);
+    FS_ProductInfo info;
+    FSUSER_GetProductInfo(&info, processId);
+    fsExit();
+    g_remaster_version = info.remasterVersion;
+  }
+
+  return g_remaster_version;
+}

reader_core/src/gen6/game_lib.rs

@@ -1,12 +1,11 @@
-use crate::title::title_id;
-use crate::title::SupportedTitle;
+use crate::title::{supported_title, SupportedTitle};
 use crate::utils::game_fn;
 
 game_fn!(xy_get_seed_hash() -> u64 = 0x10cad8);
 game_fn!(oras_get_seed_hash() -> u64 = 0x10ca94);
 
 pub fn get_seed_hash() -> u64 {
-    match title_id() {
+    match supported_title() {
         SupportedTitle::X | SupportedTitle::Y => xy_get_seed_hash(),
         SupportedTitle::Or | SupportedTitle::As => oras_get_seed_hash(),
         _ => 0,

reader_core/src/lib.rs

@@ -16,7 +16,7 @@ mod title;
 mod transporter;
 mod utils;
 
-use title::{title_id, SupportedTitle};
+use title::{supported_title, SupportedTitle};
 
 #[cfg(target_os = "horizon")]
 #[panic_handler]
@@ -45,7 +45,7 @@ fn my_panic(info: &core::panic::PanicInfo) -> ! {
 #[cfg(target_os = "horizon")]
 #[no_mangle]
 pub extern "C" fn initialize() {
-    match title_id() {
+    match supported_title() {
         SupportedTitle::S | SupportedTitle::M => gen7::init_sm(),
         SupportedTitle::Us => gen7::init_us(),
         SupportedTitle::Um => gen7::init_um(),
@@ -63,7 +63,7 @@ pub extern "C" fn initialize() {
 
 #[no_mangle]
 pub extern "C" fn run_frame() {
-    match title_id() {
+    match supported_title() {
         SupportedTitle::S | SupportedTitle::M => gen7::run_sm_frame(),
         SupportedTitle::Us | SupportedTitle::Um => gen7::run_usum_frame(),
         SupportedTitle::Or | SupportedTitle::As => gen6::run_oras_frame(),
@@ -74,6 +74,11 @@ pub extern "C" fn run_frame() {
         | SupportedTitle::CrystalFr
         | SupportedTitle::CrystalEs
         | SupportedTitle::CrystalIt => crystal::run_frame(),
-        SupportedTitle::Invalid => {}
+        SupportedTitle::Invalid => {
+            pnp::println!("Unsupported game update!");
+            pnp::println!("");
+            pnp::println!("Please update your game");
+            pnp::println!("for PokeReader to run");
+        }
     }
 }

reader_core/src/pnp/bindings.rs

@@ -7,6 +7,7 @@ extern "C" {
     pub fn host_get_game_title_id() -> u64;
     pub fn host_game_start_ms() -> u64;
     pub fn get_current_keys() -> u32;
+    pub fn get_remaster_version() -> u64;
     pub fn osGetTime() -> u64;
 }
 
@@ -40,4 +41,8 @@ pub mod test_stubs {
     pub extern "C" fn osGetTime() -> u64 {
         0
     }
+    #[no_mangle]
+    pub extern "C" fn get_remaster_version() -> u64 {
+        0
+    }
 }

reader_core/src/pnp/utils.rs

@@ -4,3 +4,7 @@ use super::bindings;
 pub fn title_id() -> u64 {
     unsafe { bindings::host_get_game_title_id() }
 }
+
+pub fn update_version() -> u64 {
+    unsafe { bindings::get_remaster_version() }
+}

reader_core/src/title.rs

@@ -22,6 +22,33 @@ pub enum SupportedTitle {
     CrystalIt = 0x0004000000173400,
 }
 
-pub fn title_id() -> SupportedTitle {
-    pnp::title_id().into()
+static mut LOADED_TITLE: SupportedTitle = SupportedTitle::Invalid;
+
+pub fn supported_title() -> SupportedTitle {
+    // Reader is single-threaded, so this is safe.
+    // Even then, title and update version will also always be the same values.
+    unsafe {
+        if LOADED_TITLE == SupportedTitle::Invalid {
+            let title = pnp::title_id().into();
+            LOADED_TITLE = match (title, pnp::update_version()) {
+                (SupportedTitle::S, 2)
+                | (SupportedTitle::M, 2)
+                | (SupportedTitle::Us, 2)
+                | (SupportedTitle::Um, 2)
+                | (SupportedTitle::Or, 7)
+                | (SupportedTitle::As, 7)
+                | (SupportedTitle::X, 5)
+                | (SupportedTitle::Y, 5)
+                | (SupportedTitle::Transporter, 5)
+                | (SupportedTitle::CrystalEn, 0)
+                | (SupportedTitle::CrystalDe, 0)
+                | (SupportedTitle::CrystalFr, 0)
+                | (SupportedTitle::CrystalEs, 0)
+                | (SupportedTitle::CrystalIt, 0) => title,
+                (_, _) => SupportedTitle::Invalid,
+            };
+        }
+
+        LOADED_TITLE
+    }
 }