hello world town hall

Author: Trolldemorted

Cargo.toml

@@ -14,6 +14,7 @@ members = [
     "mod-scrollmap-render-all-ships",
     "mod-shipyard-details",
     "mod-tavern-show-all-sailors",
+    "mod-town-hall-details",
     #"p3-agent",
     "p3-agent-loader",
     "p3-aim",
@@ -29,9 +30,12 @@ exclude = [
 version = "0.1.6"
 
 [workspace.dependencies]
-hooklet = "^0.1.5"
+#hooklet = "^0.1.5"
+hooklet = { path = "../hooklet" }
 clap = { version = "4.3.0", features = ["derive"] }
 simple_logger = "4.1"
 log = "0.4"
 sysinfo = "0.29"
 win_dbg_logger = "0.1"
+num-traits = "0.2"
+num-derive = "0.3"

mod-shipyard-details/src/ffi.rs

@@ -71,12 +71,10 @@ pub unsafe extern "thiscall" fn shipyard_window_open_hook() {
     let class48 = Class48Ptr::new();
     class48.set_ignore_below_gradient(0);
     class48.set_gradient_y(200);
-    class48.clip_stuff();
 }
 
 #[no_mangle]
 pub unsafe extern "thiscall" fn shipyard_rendering_hook() -> i32 {
-    debug!("shipyard_rendering_hook");
     let window = UIShipyardWindowPtr::new();
     let town_index = window.get_town_index();
     let selected_page = window.get_selected_page();

mod-town-hall-details/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "mod-town-hall-details"
+edition = "2021"
+version.workspace = true
+
+[lib]
+crate-type = ["cdylib"]
+name="town_hall_details"
+
+[dependencies]
+log = { workspace = true }
+win_dbg_logger = { workspace = true }
+p3-api = { path = "../p3-api" }
+hooklet = { workspace = true }
+num-traits = { workspace = true }
+num-derive = { workspace = true }
+
+[dependencies.windows]
+version = "0.48"
+features = [
+    "Win32_Foundation",
+    "Win32_System_Memory",
+]

mod-town-hall-details/src/ffi.rs

@@ -0,0 +1,165 @@
+use std::{
+    arch::global_asm,
+    ffi::{c_void, CStr, CString},
+    ptr,
+    sync::atomic::{AtomicPtr, Ordering},
+};
+
+use hooklet::{FunctionPointerHook, X86Rel32Type};
+use log::debug;
+use p3_api::{
+    data::{class48::Class48Ptr, ddraw_set_constant_color, ddraw_set_text_mode, ui_render_text_at},
+    game_world::GAME_WORLD_PTR,
+    missions::alderman_missions::{AldermanMissionDataPtr, FoundTownPtr},
+    scheduled_tasks::{
+        scheduled_task::{ScheduledTaskData, ScheduledTaskPtr},
+        SCHEDULED_TASKS_PTR,
+    },
+    ui::{
+        font::{self, get_normal_font},
+        ui_town_hall_window::UITownHallWindowPtr,
+    },
+};
+use windows::core::PCSTR;
+
+pub static TOWN: &CStr = c"Town";
+pub static TASK_DUE_IN: &CStr = c"Rescheduling in";
+pub static EFFECTIVE_PRODUCTION: &CStr = c"Effective Production";
+
+const TOWN_HALL_WINDOW_OPEN_POINTER_OFFSET: u32 = UITownHallWindowPtr::VTABLE_OFFSET + 0x120;
+pub static TOWN_HALL_WINDOW_OPEN_HOOK_PTR: AtomicPtr<FunctionPointerHook> = AtomicPtr::new(std::ptr::null_mut());
+
+const LOAD_TOWN_HALL_SELECTED_PAGE_PATCH_ADDRESS: u32 = 0x005E09AC;
+static LOAD_TOWN_HALL_SELECTED_PAGE_CONTINUATION: u32 = 0x005E09B2;
+
+#[no_mangle]
+pub unsafe extern "C" fn start() -> u32 {
+    let _ = log::set_logger(&win_dbg_logger::DEBUGGER_LOGGER);
+    log::set_max_level(log::LevelFilter::Trace);
+
+    debug!("Hooking town hall's open function through vtable");
+    match hooklet::hook_function_pointer(
+        PCSTR::from_raw(ptr::null()),
+        TOWN_HALL_WINDOW_OPEN_POINTER_OFFSET,
+        town_hall_open_hook as usize as u32,
+    ) {
+        Ok(hook) => {
+            debug!("Hook {hook:?} set");
+            TOWN_HALL_WINDOW_OPEN_HOOK_PTR.store(Box::into_raw(Box::new(hook)), Ordering::SeqCst);
+        }
+        Err(_) => {
+            return 1;
+        }
+    }
+
+    debug!("Detouring town hall's rendering function at the selected page switch");
+    if hooklet::deploy_rel32_raw(
+        LOAD_TOWN_HALL_SELECTED_PAGE_PATCH_ADDRESS as _,
+        (&load_town_hall_selected_page_detour) as *const _ as _,
+        X86Rel32Type::Jump,
+    )
+    .is_err()
+    {
+        return 2;
+    }
+
+    0
+}
+
+#[no_mangle]
+pub unsafe extern "thiscall" fn town_hall_open_hook(ui_town_hall_window_address: u32) {
+    crate::handle_open(ui_town_hall_window_address)
+}
+
+#[no_mangle]
+pub unsafe extern "thiscall" fn town_hall_rendering_hook() -> i32 {
+    crate::handle_selected_page_switch()
+}
+
+pub unsafe fn render_aldermans_office_modifications(window: &UITownHallWindowPtr) {
+    let next_mission_index = window.get_next_mission_index();
+    if next_mission_index == 0 {
+        return;
+    }
+
+    let selected_mission_index = window.get_selected_alderman_mission_index();
+    if selected_mission_index == 0xff {
+        return;
+    }
+    let task_index = window.get_task_index(selected_mission_index);
+    let task = SCHEDULED_TASKS_PTR.get_scheduled_task(task_index);
+    let data = match task.get_data() {
+        Some(e) => e,
+        None => return,
+    };
+
+    let mission = match data {
+        ScheduledTaskData::AldermanMission(mission) => mission,
+        _ => return,
+    };
+    match mission.get_data() {
+        AldermanMissionDataPtr::FoundTownPtr(ptr) => render_aldermans_office_modifications_found_town(window, &task, &ptr),
+        AldermanMissionDataPtr::OverlandTradeRoute(_ptr) => {}
+        AldermanMissionDataPtr::NotoriousPirate(_ptr) => {}
+        AldermanMissionDataPtr::PirateHideout(_ptr) => {}
+        AldermanMissionDataPtr::SupplyProblems(_ptr) => {}
+    }
+}
+
+unsafe fn render_aldermans_office_modifications_found_town(window: &UITownHallWindowPtr, task: &ScheduledTaskPtr, data: &FoundTownPtr) {
+    let town = data.get_town();
+    let effective = data.get_production_effective();
+    let class48 = Class48Ptr::new();
+    class48.set_ignore_below_gradient(0);
+    class48.set_gradient_y(0);
+
+    ddraw_set_constant_color(0xff000000);
+    ddraw_set_text_mode(2);
+    font::ddraw_set_font(get_normal_font());
+    let x = window.get_x();
+    let mut y = window.get_y() + 60;
+
+    ui_render_text_at(x + 120, y, TASK_DUE_IN.to_bytes());
+    let due_in = task.get_due_timestamp() - GAME_WORLD_PTR.get_game_time_raw();
+    let task_due_in_cstring = CString::new(format!("{due_in}")).unwrap();
+    ui_render_text_at(x + 420, y, task_due_in_cstring.to_bytes());
+    y += 20;
+
+    ui_render_text_at(x + 120, y, TOWN.to_bytes());
+    let town_cstring = CString::new(format!("{town:?}")).unwrap();
+    ui_render_text_at(x + 420, y, town_cstring.to_bytes());
+    y += 20;
+
+    ui_render_text_at(x + 120, y, EFFECTIVE_PRODUCTION.to_bytes());
+    let mut effective_string = String::new();
+    for facility in effective {
+        effective_string.push_str(&format!("{facility:?}, "));
+    }
+    effective_string.pop();
+    effective_string.pop();
+    let effective_cstring = CString::new(effective_string).unwrap();
+    ui_render_text_at(x + 420, y, effective_cstring.to_bytes());
+}
+
+extern "C" {
+    static load_town_hall_selected_page_detour: c_void;
+}
+
+global_asm!("
+.global {load_town_hall_selected_page_detour}
+{load_town_hall_selected_page_detour}:
+# save regs
+push ecx
+push edx
+
+call {town_hall_rendering_hook}
+
+# restore regs
+pop edx
+pop ecx
+
+jmp [{continuation}]
+",
+load_town_hall_selected_page_detour = sym load_town_hall_selected_page_detour,
+town_hall_rendering_hook = sym town_hall_rendering_hook,
+continuation = sym LOAD_TOWN_HALL_SELECTED_PAGE_CONTINUATION);

mod-town-hall-details/src/lib.rs

@@ -0,0 +1,123 @@
+use std::{
+    ffi::{CStr, CString},
+    mem,
+    sync::atomic::Ordering,
+};
+
+use log::debug;
+use num_traits::cast::FromPrimitive;
+use p3_api::{
+    data::{class48::Class48Ptr, ddraw_set_constant_color, ddraw_set_text_mode, enums::WareId, fill_p3_string, render_window_title, ui_render_text_at},
+    game_world::GAME_WORLD_PTR,
+    ui::{font, ui_town_hall_sidemenu::UITownHallSidemenuPtr, ui_town_hall_window::UITownHallWindowPtr},
+};
+
+pub(crate) mod ffi;
+
+pub static TITLE: &CStr = c"Details";
+pub static STOCK: &CStr = c"Stock";
+pub static CONSUMPTION: &CStr = c"Consumption";
+pub static RATIO: &CStr = c"Ratio";
+
+#[derive(Debug, Default)]
+struct HanseaticWareData {
+    total_wares: i32,
+    total_consumption: i32,
+    ware: usize,
+}
+
+impl HanseaticWareData {
+    fn get_ratio(&self) -> i32 {
+        if self.total_consumption >= 1024 {
+            self.total_wares / (self.total_consumption >> 10)
+        } else {
+            0
+        }
+    }
+}
+
+pub(crate) unsafe fn handle_open(ui_town_hall_window_address: u32) {
+    debug!("town_hall_open_hook");
+    let orig_address = (*ffi::TOWN_HALL_WINDOW_OPEN_HOOK_PTR.load(Ordering::SeqCst)).old_absolute;
+    let orig: extern "thiscall" fn(aa1: u32) = mem::transmute(orig_address);
+    orig(ui_town_hall_window_address);
+
+    let class48 = Class48Ptr::new();
+    class48.set_ignore_below_gradient(0);
+    class48.set_gradient_y(0);
+}
+
+pub(crate) unsafe fn handle_selected_page_switch() -> i32 {
+    let window = UITownHallWindowPtr::new();
+    let sidemenu = UITownHallSidemenuPtr::default();
+    let class48 = Class48Ptr::new();
+    let selected_page = window.get_selected_page();
+
+    if selected_page == -1 {
+        let mut hanse_data: [HanseaticWareData; 20] = Default::default();
+        let towns_count = GAME_WORLD_PTR.get_towns_count();
+
+        for town_index in 0..towns_count {
+            let town = GAME_WORLD_PTR.get_town(town_index as _);
+            let stock = town.get_storage().get_wares();
+            let consumption_citizens = town.get_daily_consumptions_citizens();
+            let consumption_businesses = town.get_storage().get_daily_consumptions_businesses();
+            for ware in 0..20 {
+                hanse_data[ware].total_wares += stock[ware];
+                hanse_data[ware].total_consumption += consumption_citizens[ware];
+                hanse_data[ware].total_consumption += consumption_businesses[ware];
+                hanse_data[ware].ware = ware;
+            }
+
+            let mut office_index = town.get_first_office_index();
+            while office_index < GAME_WORLD_PTR.get_offices_count() {
+                let office = GAME_WORLD_PTR.get_office(office_index);
+                let office_stock = office.get_storage().get_wares();
+                let office_consumption = office.get_storage().get_daily_consumptions_businesses();
+                for ware in 0..20 {
+                    hanse_data[ware].total_wares += office_stock[ware];
+                    hanse_data[ware].total_consumption += office_consumption[ware];
+                }
+                office_index = office.next_office_in_town_index();
+            }
+        }
+        //hanse_data.sort_by(|a, b| a.get_ratio().cmp(&b.get_ratio()));
+        hanse_data.sort_by_key(|a| a.get_ratio());
+
+        let mut title_p3_string: u32 = 0;
+        fill_p3_string((&mut title_p3_string) as *mut _ as _, TITLE.to_bytes());
+        render_window_title(title_p3_string as _, window.address as _);
+
+        ddraw_set_constant_color(0xff000000);
+        ddraw_set_text_mode(2);
+        font::ddraw_set_font(font::get_normal_font());
+        let x = window.get_x() + 80;
+        let mut y = window.get_y() + 60;
+
+        font::ddraw_set_font(font::get_header_font());
+        ui_render_text_at(x + 80, y, STOCK.to_bytes());
+        ui_render_text_at(x + 160, y, CONSUMPTION.to_bytes());
+        ui_render_text_at(x + 220, y, RATIO.to_bytes());
+        y += 20;
+
+        for data in &hanse_data {
+            let ware = WareId::from_usize(data.ware).unwrap();
+            ui_render_text_at(x, y, CString::new(format!("{ware:?}")).unwrap().to_bytes());
+            ui_render_text_at(x + 80, y, CString::new(format!("{}", data.total_wares)).unwrap().to_bytes());
+            ui_render_text_at(x + 160, y, CString::new(format!("{}", data.total_consumption)).unwrap().to_bytes());
+            if data.total_consumption >= 1024 {
+                let ratio = data.get_ratio();
+                ui_render_text_at(x + 220, y, CString::new(format!("{}", ratio)).unwrap().to_bytes());
+            }
+            y += 20;
+        }
+    } else if selected_page == 7 {
+        // The gradient changes should be done before content rendering is done, but this works for now
+        sidemenu.set_window_needs_redraw();
+        class48.set_ignore_below_gradient(0);
+        class48.set_gradient_y(0);
+        ffi::render_aldermans_office_modifications(&window);
+    }
+
+    selected_page
+}

p3-api/src/data/enums.rs

@@ -32,8 +32,10 @@ pub enum WareId {
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, EnumString, FromPrimitive)]
 #[repr(u16)]
-pub enum ProductionId {
+pub enum FacilityId {
     Militia = 0x00,
+    Shipyard = 0x01,
+    Construction = 0x02,
     Weaponsmith = 0x03,
     HuntingLodge = 0x04,
     FishermansHouse = 0x05,
@@ -129,6 +131,16 @@ pub enum BuildingId {
     Mint = 0x67,
 }
 
+#[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, FromPrimitive)]
+#[repr(u8)]
+pub enum AldermanMissionType {
+    FoundTown = 0x00,
+    OverlandTradeRoute = 0x01,
+    NotoriousPirate = 0x02,
+    PirateHideout = 0x03,
+    SupplyProblems = 0x04,
+}
+
 #[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, FromPrimitive)]
 #[repr(u8)]
 // Extended from https://github.com/Sqoops/PatrizierKartenEditor

p3-api/src/data/mod.rs

@@ -110,8 +110,8 @@ pub fn fill_p3_string(p3_string: *const c_void, input: &[u8]) {
     function(p3_string, input.as_ptr() as _)
 }
 
-pub fn ui_render_text_at(x: i32, y: i32, text: &[u8]) {
-    let function: extern "cdecl" fn(x: i32, y: i32, text: *const c_void) = unsafe { mem::transmute(0x004BB3E0) };
+pub unsafe fn ui_render_text_at(x: i32, y: i32, text: &[u8]) {
+    let function: extern "cdecl" fn(x: i32, y: i32, text: *const c_void) = mem::transmute(0x004BB3E0);
     function(x, y, text.as_ptr() as _)
 }
 

p3-api/src/data/office.rs

@@ -20,7 +20,7 @@ impl OfficePtr {
         unsafe { self.get(0x2c4) }
     }
 
-    pub fn next_office_id(&self) -> u16 {
+    pub fn next_office_in_town_index(&self) -> u16 {
         unsafe { self.get(0x2ca) }
     }
 }