feat(layouts): override layout anchor points with user settings (#108)

Players can now choose to override a layout's chosen anchor point
with their own preferred HUD location. This won't work well for
every layout, but players can decide that for themselves.

Added the new option to the settings struct and MCM config. It's an 
enum that allows players to choose from the current list of anchor 
names. Added new translation strings to support the config.

`apply_settings()` now refreshes the layout to pick up any
location changes.

Added a test to ensure that the setting is respected by the
anchor_point() function if set. This bottleneck ensures that
flattened layouts get the overridden location automatically.
To support the test, added a way to specific a refresh-from file
for the settings lazy static. The new convenience functions to
Layout that match on its variants are also there to support tests.

installer/core/mcm/config/SoulsyHUD/settings.ini

@@ -33,6 +33,7 @@ bGroupPotions = 0
 bCycleAmmo = 1
 bColorizeIcons = 1
 bEquipSetsUnequip = 1
+uAnchorLocation = none
 sSKSEIdentifier = SOLS
 bDebugMode = 0
 sLogLevel = info

src/controller/control.rs

@@ -175,6 +175,9 @@ impl Controller {
             }
         }
 
+        // Apply any new anchor relocations to the current layout.
+        Layout::refresh();
+
         self.cache.introspect();
     }
 

src/controller/settings.rs

@@ -12,7 +12,7 @@ use once_cell::sync::Lazy;
 use strum::Display;
 
 use super::keys::Hotkey;
-use crate::plugin::HudElement;
+use crate::{layouts::shared::NamedAnchor, plugin::HudElement};
 
 /// This is the path to players's modified settings.
 static SETTINGS_PATH: &str = "./data/MCM/Settings/SoulsyHUD.ini";
@@ -100,6 +100,8 @@ pub struct UserSettings {
     showhide: u32,
     /// A hotkey for re-reading the layout from toml and redrawing. uRefreshKey
     refresh_layout: u32,
+    /// Layout anchor override. uAnchorLocation
+    anchor_loc: NamedAnchor,
 
     /// The number of milliseconds to delay before equipping a selection. Max 2500, min 0.
     equip_delay_ms: u32,
@@ -141,6 +143,7 @@ impl Default for UserSettings {
             right: 7,
             equipset: 9,
             refresh_layout: 8,
+            anchor_loc: NamedAnchor::None,
             how_to_activate: ActivationMethod::Hotkey,
             activate: 4,
             activate_modifier: -1,
@@ -184,6 +187,13 @@ impl UserSettings {
         settings.read_from_file(SETTINGS_PATH)
     }
 
+    pub fn refresh_with(fpath: &str) -> Result<()> {
+        let mut settings = SETTINGS
+            .lock()
+            .expect("Unrecoverable runtime problem: cannot acquire settings lock.");
+        settings.read_from_file(fpath)
+    }
+
     /// Refresh ourselves from the MCM-controlled file.
     pub fn read_from_file(&mut self, fpath: &str) -> Result<()> {
         // We'll fall back to defaults at a different level.
@@ -231,6 +241,7 @@ impl UserSettings {
 
         self.showhide = read_from_ini(self.showhide, "uShowHideKey", controls);
         self.refresh_layout = read_from_ini(self.refresh_layout, "uRefreshKey", controls);
+        self.anchor_loc = read_from_ini(self.anchor_loc.clone(), "uAnchorLocation", options);
 
         self.unarmed_handling = read_from_ini(self.unarmed_handling, "uHowToUnequip", controls);
         self.unequip_modifier =
@@ -404,6 +415,9 @@ impl UserSettings {
     pub fn refresh_layout(&self) -> u32 {
         self.refresh_layout
     }
+    pub fn anchor_loc(&self) -> &NamedAnchor {
+        &self.anchor_loc
+    }
     pub fn maxlen(&self) -> u32 {
         20
     }
@@ -591,6 +605,31 @@ impl FromIniStr for String {
     }
 }
 
+impl FromIniStr for NamedAnchor {
+    fn from_ini(value: &str) -> Option<Self>
+    where
+        Self: Sized,
+    {
+        if let Ok(v) = value.parse::<i32>() {
+            match v {
+                0 => Some(NamedAnchor::None),
+                1 => Some(NamedAnchor::TopLeft),
+                2 => Some(NamedAnchor::TopRight),
+                3 => Some(NamedAnchor::BottomLeft),
+                4 => Some(NamedAnchor::BottomRight),
+                5 => Some(NamedAnchor::Center),
+                6 => Some(NamedAnchor::CenterTop),
+                7 => Some(NamedAnchor::CenterBottom),
+                8 => Some(NamedAnchor::LeftCenter),
+                9 => Some(NamedAnchor::LeftCenter),
+                _ => Some(NamedAnchor::None),
+            }
+        } else {
+            None
+        }
+    }
+}
+
 // qualified so we don't collide with the macro strum::Display
 // We implement this so the logs contain a human-readable dump of the settings
 // at save game load, so people can debug.
@@ -606,6 +645,7 @@ impl std::fmt::Display for UserSettings {
              right cycle key: {}
           equipset cycle key: {}
           refresh layout key: {}
+      layout anchor override: {}
              how_to_activate: {}
         activate consumables: {}
            activate_modifier: {}
@@ -638,6 +678,7 @@ impl std::fmt::Display for UserSettings {
             self.right,
             self.equipset,
             self.refresh_layout,
+            self.anchor_loc,
             self.how_to_activate,
             self.activate,
             self.activate_modifier,

src/layouts/mod.rs

@@ -17,6 +17,7 @@ use serde::{Deserialize, Serialize};
 use self::shared::NamedAnchor;
 use crate::control::notify;
 use crate::controller::control::translated_key;
+use crate::controller::user_settings;
 use crate::plugin::{LayoutFlattened, Point};
 
 static LAYOUT_PATH: &str = "./data/SKSE/Plugins/SoulsyHUD_Layout.toml";
@@ -35,7 +36,7 @@ pub fn hud_layout() -> LayoutFlattened {
     layout.clone()
 }
 
-#[derive(Serialize, Deserialize)]
+#[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(untagged)]
 pub enum Layout {
     Version1(Box<HudLayout1>),
@@ -121,6 +122,13 @@ impl Layout {
             Layout::Version2(v) => LayoutFlattened::from(&**v),
         }
     }
+
+    pub fn anchor_point(&self) -> Point {
+        match self {
+            Layout::Version1(v) => v.anchor_point(),
+            Layout::Version2(v) => v.anchor_point(),
+        }
+    }
 }
 
 pub fn anchor_point(
@@ -137,7 +145,16 @@ pub fn anchor_point(
     let width = size.x * global_scale;
     let height = size.y * global_scale;
 
-    match anchor_name {
+    let config = *user_settings();
+    let user_pref_anchor = config.anchor_loc();
+    eprintln!("{user_pref_anchor}");
+    let anchor_to_use = if !matches!(user_pref_anchor, &NamedAnchor::None) {
+        user_pref_anchor
+    } else {
+        anchor_name
+    };
+
+    match anchor_to_use {
         NamedAnchor::TopLeft => Point {
             x: width / 2.0,
             y: height / 2.0,
@@ -322,4 +339,26 @@ mod tests {
         );
         assert_eq!(pointed.anchor_point(), named.anchor_point());
     }
+
+    #[test]
+    fn anchor_points_respect_settings() {
+        // override the defaults with what we need for this test
+        let _ = crate::controller::UserSettings::refresh_with("tests/fixtures/test-settings.ini");
+
+        let named = Layout::read_from_file("tests/fixtures/named-anchor.toml")
+            .expect("this test fixture exists and is valid");
+        // this layout has bottom left as an anchor point
+        // the test settings override with "center"
+        let relocated = named.anchor_point();
+        assert_eq!(
+            relocated,
+            Point {
+                x: 1720.0,
+                y: 720.0
+            }
+        );
+
+        let flattened = named.flatten();
+        assert_eq!(flattened.anchor, relocated);
+    }
 }

src/layouts/shared.rs

@@ -132,6 +132,28 @@ where
     }
 }
 
+impl From<&str> for NamedAnchor {
+    fn from(s: &str) -> Self {
+        match s.to_lowercase().as_str() {
+            "top_left" => NamedAnchor::TopLeft,
+            "top_right" => NamedAnchor::TopRight,
+            "bottom_left" => NamedAnchor::BottomLeft,
+            "bottom_right" => NamedAnchor::BottomRight,
+            "center" => NamedAnchor::Center,
+            "center_top" => NamedAnchor::CenterTop,
+            "top_center" => NamedAnchor::CenterTop,
+            "center_bottom" => NamedAnchor::CenterBottom,
+            "bottom_center" => NamedAnchor::CenterBottom,
+            "left_center" => NamedAnchor::LeftCenter,
+            "center_left" => NamedAnchor::LeftCenter,
+            "right_center" => NamedAnchor::RightCenter,
+            "center_right" => NamedAnchor::RightCenter,
+            "none" => NamedAnchor::None,
+            _ => NamedAnchor::None,
+        }
+    }
+}
+
 // ---------- MeterType
 
 // We can't derive this because it is exposed to C++.

tests/fixtures/all-types.ini

@@ -12,6 +12,7 @@ bBooleanStringF = false
 bBooleanEmpty =
 sString = String with spaces
 sStringEmpty =
+uNamedAnchor = "top_left"
 
 [emptysection]
 

tests/fixtures/test-settings.ini

@@ -0,0 +1,34 @@
+[Options]
+bCycleAmmo = 1
+bAutoFade = 1
+bGroupPotions = 1
+bDebugMode = 1
+sSKSEIdentifier = WOMP
+bLinkToFavorites = 1
+bEquipSetsUnequip = 1
+sLogLevel = debug
+bCyclingSlowsTime = 1
+uFadeTime = 1500
+uEquipDelay = 2500
+uLongPressMillis = 2750
+uAnchorLocation = 5
+
+[Controls]
+uRefreshKey = 8
+uShowHideKey = 2
+uHowToUnequip = 0
+bLongPressMatches = 1
+iUnequipModifierKey = 184
+uPowerCycleKey = 3
+uLeftCycleKey = 5
+uRightCycleKey = 7
+uUtilityCycleKey = 6
+uHowToActivate = 0
+uHowToggleInMenus = 0
+iMenuModifierKey = 42
+iUtilityActivateModifier = 274
+
+
+[Equipsets]
+sLastEditedSetName = Mossy
+sLastUsedSetName = Spiky