Merge pull request #87 from rickfay/charm-improvements

Make the Charm item less confusing

Author: rickfay

presets/Example.json

@@ -1,7 +1,7 @@
 {
   // "Visit the project GitHub for details about each option: https://github.com/rickfay/z17-randomizer/tree/dev#game-options"
   "seed": 0,
-  "version": "v0.4.0 - Beta Build 2025-01-16",
+  "version": "v0.4.0 - Beta Build 2025-02-06",
   "settings": {
 
 

randomizer/src/constants.rs

@@ -1,5 +1,5 @@
 //! Application Constants
 
 /// Build Version
-pub const VERSION: &str = "v0.4.0 - Beta Build 2025-01-16";
+pub const VERSION: &str = "v0.4.0 - Beta Build 2025-02-06";
 pub const CONFIG_FILE_NAME: &str = "config.json";

randomizer/src/patch/code/mod.rs

@@ -1,18 +1,18 @@
 use super::Patcher;
 use crate::filler::filler_item::Item::*;
 use crate::filler::filler_item::Randomizable;
+use crate::patch::code::arm::Register::*;
 use crate::patch::code::arm::data::{add, cmp, mov};
 use crate::patch::code::arm::ls::{ldr, ldrb, str_, strb};
 use crate::patch::code::arm::lsm::{pop, push};
-use crate::patch::code::arm::Register::*;
-use crate::patch::code::arm::{b, bl, Instruction, LR, PC, SP};
-use crate::{patch::util::prize_flag, regions, Layout, Result, SeedInfo};
+use crate::patch::code::arm::{Instruction, LR, PC, SP, b, bl};
+use crate::{Layout, Result, SeedInfo, patch::util::prize_flag, regions};
 use game::Item;
 use game::Item::*;
-use modinfo::settings::{pedestal::PedestalSetting::*, Settings};
+use modinfo::settings::{Settings, pedestal::PedestalSetting::*};
+use rom::ExHeader;
 use rom::flag::Flag;
 use rom::scene::SpawnPoint;
-use rom::ExHeader;
 use std::{
     collections::HashMap,
     fs::{self, File},
@@ -178,6 +178,7 @@ pub fn create(patcher: &Patcher, seed_info: &SeedInfo) -> Code {
     // instant text
     code.overwrite(0x17A430, [0xFF]);
 
+    remove_charm_from_gear_menu(&mut code);
     fix_joystick_rotation(&mut code);
     rental_items(&mut code);
     progressive_items(&mut code);
@@ -351,6 +352,14 @@ fn do_dev_stuff(code: &mut Code, seed_info: &SeedInfo) {
     code.patch(0x2559c0, [add(R2, R2, amount)]);
 }
 
+/// The game will show a green orb on the gear menu whether you have the Charm or the full Pendant
+/// of Courage. This gets confusing for players who don't understand that the Charm is a junk item
+/// that does nothing. This code prevents the green orb from appearing with the Charm, and will
+/// make it only appear when the player has the actual Pendant of Courage.
+fn remove_charm_from_gear_menu(code: &mut Code) {
+    code.text().patch(0x42644c, [b(0x4264a8).ne()]);
+}
+
 /// For what are certainly reasons, Nintendo decided to rotate all of Link's movements ever so
 /// slightly (about 5 degrees) counterclockwise in the vanilla game. This isn't often complained
 /// about by people who play on physical 3DS hardware because reasons, but is very jarring to folks

randomizer/src/patch/messages/mod.rs

@@ -133,7 +133,7 @@ fn patch_event_item_get(patcher: &mut Patcher) -> Result<()> {
     msbt.set("item_sandrod", "You got the Sand Rod!");
 
     msbt.set("kandelaar", "You got the lamp!");
-    msbt.set("zelda_amulet", "You got a special charm!"); // Cut " from Princess Zelda"
+    msbt.set("zelda_amulet", &format!("You got a special charm!\nIt's {}!", attention("useless"))); // Cut " from Princess Zelda"
 
     patcher.update(msbt.dump())?;