Improve SOS, add help menu, and fix friendship (#70)

Author: serenagrace

Makefile

@@ -21,6 +21,9 @@ clean:
 	make clean -C 3gx
 	rm -rf out
 
+format:
+	cargo +nightly fmt --all --manifest-path reader_core/Cargo.toml
+
 lint:
 	cargo +nightly-2024-03-21 clippy --release -Z build-std=core,alloc --target armv6k-nintendo-3ds --manifest-path reader_core/Cargo.toml
 

README.md

@@ -16,6 +16,9 @@ This information can be used to RNG shiny and high IV Pokemon, similar to lua sc
 - Start + Select: Pause game and enable manual frame advancing
 - Select: Advance one frame while paused
 - Start or A: Unpause game
+- SOS Menu Commands:
+    - X + Right (D-Pad): Set SOS Caller slot to current Ally slot
+    - X + Up/Down: Manually increment/decrement Caller slot
 
 ## Installing
 

reader_core/Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "pokereader"
-version = "0.7.4"
+version = "0.8.0"
 edition = "2021"
 
 [dependencies]

reader_core/Cargo.toml

@@ -8,11 +8,7 @@ fn get_tree_state() -> &'static str {
         .unwrap()
         .stdout
         .is_empty();
-    if is_clean {
-        ""
-    } else {
-        "dirty-"
-    }
+    if is_clean { "" } else { "dirty-" }
 }
 
 fn get_hash() -> String {
@@ -30,9 +26,5 @@ fn get_hash() -> String {
 }
 
 fn main() {
-    println!(
-        "cargo:rustc-env=GIT_HASH={}{}",
-        get_tree_state(),
-        get_hash()
-    );
+    println!("cargo:rustc-env=GIT_HASH={}{}", get_tree_state(), get_hash());
 }

reader_core/build.rs

@@ -0,0 +1,2 @@
+style_edition = "2024"
+max_width = 110

reader_core/rustfmt.toml

@@ -7,6 +7,7 @@ use crate::pnp::{self, Button};
 const WHITE: u32 = 0xffffff;
 const GREEN: u32 = 0x003c00;
 const RED: u32 = 0x1f0000;
+pub const CRYSTAL_CYAN: u32 = 0x003c3c;
 
 fn get_iv_color(iv: u8) -> u32 {
     match iv {
@@ -42,11 +43,7 @@ pub fn draw_rng(reader: &Gen2Reader) {
 pub fn draw_pkx(pkx: &Pk2) {
     pnp::println!("Species: {}", pkx.species);
     pnp::println!(color = get_shiny_color(pkx.shiny), "Shiny: {}", pkx.shiny);
-    pnp::println!(
-        "HPower: {} {}",
-        pkx.hidden_power_type,
-        pkx.hidden_power_base
-    );
+    pnp::println!("HPower: {} {}", pkx.hidden_power_type, pkx.hidden_power_base);
     pnp::println!(color = get_iv_color(pkx.hp), "HP  DV: {}", pkx.hp);
     pnp::println!(color = get_iv_color(pkx.atk), "Atk DV: {}", pkx.atk);
     pnp::println!(color = get_iv_color(pkx.def), "Def DV: {}", pkx.def);

reader_core/src/crystal/draw.rs

@@ -6,9 +6,10 @@ use super::{
 use crate::{
     pnp,
     utils::{
+        ShowView,
+        help_menu::HelpMenu,
         menu::{Menu, MenuOption, MenuOptionValue},
         sub_menu::SubMenu,
-        ShowView,
     },
 };
 use once_cell::unsync::Lazy;
@@ -20,6 +21,7 @@ enum CrystalView {
     Party,
     Wild,
     NonCfw,
+    HelpMenu,
 }
 
 impl MenuOptionValue for CrystalView {
@@ -30,6 +32,7 @@ impl MenuOptionValue for CrystalView {
             Self::Party => "Party",
             Self::Wild => "Wild",
             Self::NonCfw => "Non-CFW",
+            Self::HelpMenu => "Help",
         }
     }
 }
@@ -38,8 +41,9 @@ struct PersistedState {
     frame: usize,
     show_view: ShowView,
     view: CrystalView,
-    main_menu: Menu<4, CrystalView>,
+    main_menu: Menu<5, CrystalView>,
     party_menu: SubMenu<1, 6>,
+    help_menu: HelpMenu,
 }
 
 unsafe fn get_state() -> &'static mut PersistedState {
@@ -48,11 +52,13 @@ unsafe fn get_state() -> &'static mut PersistedState {
         show_view: ShowView::default(),
         view: CrystalView::MainMenu,
         party_menu: SubMenu::default(),
+        help_menu: HelpMenu::default(),
         main_menu: Menu::new([
             MenuOption::new(CrystalView::Rng),
             MenuOption::new(CrystalView::Party),
             MenuOption::new(CrystalView::Wild),
             MenuOption::new(CrystalView::NonCfw),
+            MenuOption::new(CrystalView::HelpMenu),
         ]),
     });
     Lazy::force_mut(&mut STATE)
@@ -91,6 +97,7 @@ pub fn run_frame() {
             draw_pkx(&reader.party((slot - 1) as u8));
         }
         CrystalView::NonCfw => draw_non_cfw(&reader, state.frame),
+        CrystalView::HelpMenu => state.help_menu.update_and_draw(is_locked),
         CrystalView::MainMenu => {
             state.main_menu.update_view();
             state.main_menu.draw();

reader_core/src/crystal/frame.rs

@@ -5,5 +5,6 @@ mod hook;
 mod pk2;
 mod reader;
 
+pub use draw::CRYSTAL_CYAN;
 pub use frame::run_frame;
 pub use hook::init_crystal;

reader_core/src/crystal/mod.rs

@@ -253,15 +253,53 @@ const SPECIES_LOOKUP: [&str; 252] = [
     "Celebi",
 ];
 
+#[rustfmt::skip]
 const NATURE_LOOKUP: [&str; 25] = [
-    "Hardy", "Lonely", "Brave", "Adamant", "Naughty", "Bold", "Docile", "Relaxed", "Impish", "Lax",
-    "Timid", "Hasty", "Serious", "Jolly", "Naive", "Modest", "Mild", "Quiet", "Bashful", "Rash",
-    "Calm", "Gentle", "Sassy", "Careful", "Quirky",
+    "Hardy",
+    "Lonely",
+    "Brave",
+    "Adamant",
+    "Naughty",
+    "Bold",
+    "Docile",
+    "Relaxed",
+    "Impish",
+    "Lax",
+    "Timid",
+    "Hasty",
+    "Serious",
+    "Jolly",
+    "Naive",
+    "Modest",
+    "Mild",
+    "Quiet",
+    "Bashful",
+    "Rash",
+    "Calm",
+    "Gentle",
+    "Sassy",
+    "Careful",
+    "Quirky",
 ];
 
+#[rustfmt::skip]
 const HIDDEN_POWER_LOOKUP: [&str; 16] = [
-    "Fighting", "Flying", "Poison", "Ground", "Rock", "Bug", "Ghost", "Steel", "Fire", "Water",
-    "Grass", "Electric", "Psychic", "Ice", "Dragon", "Dark",
+    "Fighting",
+    "Flying",
+    "Poison",
+    "Ground",
+    "Rock",
+    "Bug",
+    "Ghost",
+    "Steel",
+    "Fire",
+    "Water",
+    "Grass",
+    "Electric",
+    "Psychic",
+    "Ice",
+    "Dragon",
+    "Dark",
 ];
 
 pub struct Pk2 {
@@ -299,9 +337,7 @@ impl Pk2 {
         Pk2 {
             spec_index,
             species: SPECIES_LOOKUP.get(spec_index as usize).unwrap_or(&"None"),
-            nature: NATURE_LOOKUP
-                .get(experience as usize % 25)
-                .unwrap_or(&"Unknown"),
+            nature: NATURE_LOOKUP.get(experience as usize % 25).unwrap_or(&"Unknown"),
             experience,
             atk,
             def,
@@ -313,12 +349,7 @@ impl Pk2 {
                 .get(((atk & 3) << 2 | def & 3) as usize)
                 .unwrap_or(&"Unknown"),
             hidden_power_base: 31
-                + (5 * ((atk >> 3) << 3
-                    | (def >> 3) << 2
-                    | (spe >> 3) << 1
-                    | (spc >> 3))
-                    + (spc & 3))
-                    / 2,
+                + (5 * ((atk >> 3) << 3 | (def >> 3) << 2 | (spe >> 3) << 1 | (spc >> 3)) + (spc & 3)) / 2,
         }
     }
 }