feat(action): add MCM action

CMakeLists.txt

@@ -89,6 +89,8 @@ else()
         src/InputHandler.h
         src/InputHandler.cpp
         src/LongPressAction.h
+        src/MCMNavigator.h
+        src/MCMNavigator.cpp
         src/MenuUI.h
         src/MenuUI.cpp
         src/Plugin.cpp

HoldFast.ini

@@ -2,8 +2,16 @@
 ; Duration in seconds a button must be held to trigger its long-press action (default: 0.5, max: 5.0)
 fHoldDuration=0.5
 ; Long-press action for the Start (Menu) button. Short press performs the button's normal function.
-; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None (case-insensitive)
+; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
 sButtonStartAction=Map
+; Mod to open when sButtonStartAction=MCM. Leave as None to open the MCM mod list.
+sButtonStartMCMModName=None
+; Close the journal automatically when leaving a MCM mod page via Start. Only applies when sButtonStartAction=MCM.
+bButtonStartMCMQuickexit=true
 ; Long-press action for the Back (View) button. Short press performs the button's normal function.
-; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None (case-insensitive)
+; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
 sButtonBackAction=System
+; Mod to open when sButtonBackAction=MCM. Leave as None to open the MCM mod list.
+sButtonBackMCMModName=None
+; Close the journal automatically when leaving a MCM mod page via Back. Only applies when sButtonBackAction=MCM.
+bButtonBackMCMQuickexit=true

README.md

@@ -42,11 +42,19 @@ Edit `Data\SKSE\Plugins\HoldFast.ini`:
 ; Duration in seconds a button must be held to trigger its long-press action (default: 0.5, max: 5.0)
 fHoldDuration=0.5
 ; Long-press action for the Start (Menu) button. Short press performs the button's normal function.
-; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None (case-insensitive)
+; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
 sButtonStartAction=Map
+; Mod to open when sButtonStartAction=MCM. Leave as None to open the MCM mod list.
+sButtonStartMCMModName=None
+; Close the journal automatically when leaving a MCM mod page via Start. Only applies when sButtonStartAction=MCM.
+bButtonStartMCMQuickexit=true
 ; Long-press action for the Back (View) button. Short press performs the button's normal function.
-; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None (case-insensitive)
+; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
 sButtonBackAction=System
+; Mod to open when sButtonBackAction=MCM. Leave as None to open the MCM mod list.
+sButtonBackMCMModName=None
+; Close the journal automatically when leaving a MCM mod page via Back. Only applies when sButtonBackAction=MCM.
+bButtonBackMCMQuickexit=true
 ```
 
 **In-game settings (optional):**
@@ -56,22 +64,23 @@ Use **Save to config** to persist and apply changes, **Reload from config** to d
 
 **Valid actions:**
 
-| Value            | What it does                                   |
-| ---------------- | ---------------------------------------------- |
-| `Map`            | Opens the map                                  |
-| `System`         | Opens the Journal on the System tab            |
-| `Quests`         | Opens the Journal on the Quests tab            |
-| `Stats`          | Opens the Journal on the Stats tab             |
-| `Inventory`      | Opens the inventory                            |
-| `Magic`          | Opens the magic menu                           |
-| `Favorites`      | Opens the favourites menu                      |
-| `TweenMenu`      | Opens the tween menu (Items/Magic/Map/Skills)  |
-| `Wait`           | Opens the sleep/wait menu                      |
-| `NewSave`        | Performs a new save                            |
-| `QuickSave`      | Performs a quicksave                           |
-| `Bestiary`       | Opens The Dragonborn's Bestiary (requires mod) |
-| `CharacterSheet` | Opens Character Menu SE (requires mod)         |
-| `None`           | Button not intercepted                         |
+| Value            | What it does                                                  |
+| ---------------- | ------------------------------------------------------------- |
+| `Map`            | Opens the map                                                 |
+| `System`         | Opens the Journal on the System tab                           |
+| `Quests`         | Opens the Journal on the Quests tab                           |
+| `Stats`          | Opens the Journal on the Stats tab                            |
+| `Inventory`      | Opens the inventory                                           |
+| `Magic`          | Opens the magic menu                                          |
+| `Favorites`      | Opens the favourites menu                                     |
+| `TweenMenu`      | Opens the tween menu (Items/Magic/Map/Skills)                 |
+| `Wait`           | Opens the sleep/wait menu                                     |
+| `NewSave`        | Performs a new save                                           |
+| `QuickSave`      | Performs a quicksave                                          |
+| `Bestiary`       | Opens The Dragonborn's Bestiary (requires mod)                |
+| `CharacterSheet` | Opens Character Menu SE (requires mod)                        |
+| `MCM`            | Opens the MCM. Optionally navigates to a specific mod's page. |
+| `None`           | Button not intercepted                                        |
 
 Logs are written to:
 

src/Config.cpp

@@ -32,6 +32,21 @@ namespace
 		logger::warn("fHoldDuration ({:.2f}) exceeds maximum {:.1f} — capping", raw, HoldFast::kMaxHoldDuration);
 		return duration;
 	}
+
+	[[nodiscard]] std::string GetMCMTarget(const CSimpleIniA& ini, const char* modKey)
+	{
+		const char* raw = ini.GetValue("General", modKey, nullptr);
+		if (!raw) {
+			return "None";
+		}
+		const auto trimmed = HoldFast::TrimWhitespace(raw);
+		if (trimmed.empty()) {
+			return "None";
+		}
+		std::string lower{ trimmed };
+		std::ranges::transform(lower, lower.begin(), [](unsigned char c) { return static_cast<char>(std::tolower(c)); });
+		return lower == "none" ? "None" : std::string{ trimmed };
+	}
 }
 
 HoldFast::Config::Settings HoldFast::Config::LoadSettings()
@@ -56,14 +71,16 @@ HoldFast::Config::Settings HoldFast::Config::LoadSettings()
 		return settings;
 	}
 
+	constexpr auto kValidActions = "Map, System, Quests, Stats, Inventory, Magic, Favorites/Favourites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None";
+
 	settings.startAction = hasStart ? ParseAction(rawStart) : LongPressAction::kNone;
 	if (hasStart && settings.startAction == LongPressAction::kNone) {
 		std::string lower{ HoldFast::TrimWhitespace(rawStart) };
 		for (auto& c : lower) {
 			c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
 		}
 		if (lower != "none") {
-			logger::warn("sButtonStartAction='{}' is not a recognised action (valid: Map, System, Quests, Stats, Inventory, Magic, Favorites/Favourites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None) — disabling button", rawStart);
+			logger::warn("sButtonStartAction='{}' is not a recognised action (valid: {}) — disabling button", rawStart, kValidActions);
 		}
 	}
 	settings.backAction = hasBack ? ParseAction(rawBack) : LongPressAction::kNone;
@@ -73,9 +90,15 @@ HoldFast::Config::Settings HoldFast::Config::LoadSettings()
 			c = static_cast<char>(std::tolower(static_cast<unsigned char>(c)));
 		}
 		if (lower != "none") {
-			logger::warn("sButtonBackAction='{}' is not a recognised action (valid: Map, System, Quests, Stats, Inventory, Magic, Favorites/Favourites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, None) — disabling button", rawBack);
+			logger::warn("sButtonBackAction='{}' is not a recognised action (valid: {}) — disabling button", rawBack, kValidActions);
 		}
 	}
+
+	settings.startMCMModName = GetMCMTarget(ini, "sButtonStartMCMModName");
+	settings.backMCMModName = GetMCMTarget(ini, "sButtonBackMCMModName");
+	settings.startMCMQuickexit = ini.GetBoolValue("General", "bButtonStartMCMQuickexit", true);
+	settings.backMCMQuickexit = ini.GetBoolValue("General", "bButtonBackMCMQuickexit", true);
+
 	return settings;
 }
 
@@ -92,6 +115,10 @@ bool HoldFast::Config::SaveSettings(const Settings& settings)
 	ini.SetValue("General", "fHoldDuration", holdDurationStr.c_str());
 	ini.SetValue("General", "sButtonStartAction", startActionName.c_str());
 	ini.SetValue("General", "sButtonBackAction", backActionName.c_str());
+	ini.SetValue("General", "sButtonStartMCMModName", settings.startMCMModName.c_str());
+	ini.SetValue("General", "sButtonBackMCMModName", settings.backMCMModName.c_str());
+	ini.SetBoolValue("General", "bButtonStartMCMQuickexit", settings.startMCMQuickexit);
+	ini.SetBoolValue("General", "bButtonBackMCMQuickexit", settings.backMCMQuickexit);
 
 	const auto rc = ini.SaveFile(kIniPath);
 	if (rc < SI_OK) {
@@ -107,10 +134,22 @@ std::vector<ButtonConfig> HoldFast::Config::BuildButtons(const Settings& setting
 
 	std::vector<ButtonConfig> buttons;
 	if (settings.startAction != LongPressAction::kNone) {
-		buttons.push_back({ .keyCode = static_cast<std::uint32_t>(Key::kStart), .name = "Start", .action = settings.startAction });
+		buttons.push_back({
+			.keyCode = static_cast<std::uint32_t>(Key::kStart),
+			.name = "Start",
+			.action = settings.startAction,
+			.mcmModName = settings.startMCMModName,
+			.mcmQuickexit = settings.startMCMQuickexit,
+		});
 	}
 	if (settings.backAction != LongPressAction::kNone) {
-		buttons.push_back({ .keyCode = static_cast<std::uint32_t>(Key::kBack), .name = "Back", .action = settings.backAction });
+		buttons.push_back({
+			.keyCode = static_cast<std::uint32_t>(Key::kBack),
+			.name = "Back",
+			.action = settings.backAction,
+			.mcmModName = settings.backMCMModName,
+			.mcmQuickexit = settings.backMCMQuickexit,
+		});
 	}
 	return buttons;
 }

src/Config.h

@@ -15,6 +15,10 @@ namespace HoldFast::Config
 		float           holdDuration{ HoldFast::kDefaultHoldDuration };
 		LongPressAction startAction{ LongPressAction::kMap };
 		LongPressAction backAction{ LongPressAction::kSystem };
+		std::string     startMCMModName{ "None" };
+		std::string     backMCMModName{ "None" };
+		bool            startMCMQuickexit{ true };
+		bool            backMCMQuickexit{ true };
 	};
 
 	struct ActionOption
@@ -23,7 +27,7 @@ namespace HoldFast::Config
 		LongPressAction action;
 	};
 
-	inline constexpr std::array<ActionOption, 14> kActionOptions{ {
+	inline constexpr std::array<ActionOption, 15> kActionOptions{ {
 		{ "Map", LongPressAction::kMap },
 		{ "System", LongPressAction::kSystem },
 		{ "Quests", LongPressAction::kQuests },
@@ -37,6 +41,7 @@ namespace HoldFast::Config
 		{ "QuickSave", LongPressAction::kQuickSave },
 		{ "Bestiary", LongPressAction::kBestiary },
 		{ "CharacterSheet", LongPressAction::kCharacterSheet },
+		{ "MCM", LongPressAction::kMCM },
 		{ "None", LongPressAction::kNone },
 	} };
 

src/ConfigParsing.cpp

@@ -21,6 +21,7 @@ LongPressAction HoldFast::Config::ParseAction(std::string_view raw)
 		{ "quicksave", LongPressAction::kQuickSave },
 		{ "bestiary", LongPressAction::kBestiary },
 		{ "charactersheet", LongPressAction::kCharacterSheet },
+		{ "mcm", LongPressAction::kMCM },
 		{ "none", LongPressAction::kNone },
 	};