Skip to content

Commit c3e2e3f

Browse files
committed
chore(docs): clarify MCM mod name format with example
1 parent 96ffc4c commit c3e2e3f

3 files changed

Lines changed: 10 additions & 6 deletions

File tree

‎HoldFast.ini‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ fHoldDuration=0.5
44
; Long-press action for the Start (Menu) button. Short press performs the button's normal function.
55
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
66
sButtonStartAction=Map
7-
; Mod to open when sButtonStartAction=MCM. Leave as None to open the MCM mod list.
7+
; Mod to open when sButtonStartAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
88
sButtonStartMCMModName=None
99
; Close the journal automatically when leaving a MCM mod page via Start. Only applies when sButtonStartAction=MCM.
1010
bButtonStartMCMQuickexit=true
1111
; Long-press action for the Back (View) button. Short press performs the button's normal function.
1212
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
1313
sButtonBackAction=System
14-
; Mod to open when sButtonBackAction=MCM. Leave as None to open the MCM mod list.
14+
; Mod to open when sButtonBackAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
1515
sButtonBackMCMModName=None
1616
; Close the journal automatically when leaving a MCM mod page via Back. Only applies when sButtonBackAction=MCM.
1717
bButtonBackMCMQuickexit=true

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ fHoldDuration=0.5
4444
; Long-press action for the Start (Menu) button. Short press performs the button's normal function.
4545
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
4646
sButtonStartAction=Map
47-
; Mod to open when sButtonStartAction=MCM. Leave as None to open the MCM mod list.
47+
; Mod to open when sButtonStartAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
4848
sButtonStartMCMModName=None
4949
; Close the journal automatically when leaving a MCM mod page via Start. Only applies when sButtonStartAction=MCM.
5050
bButtonStartMCMQuickexit=true
5151
; Long-press action for the Back (View) button. Short press performs the button's normal function.
5252
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
5353
sButtonBackAction=System
54-
; Mod to open when sButtonBackAction=MCM. Leave as None to open the MCM mod list.
54+
; Mod to open when sButtonBackAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
5555
sButtonBackMCMModName=None
5656
; Close the journal automatically when leaving a MCM mod page via Back. Only applies when sButtonBackAction=MCM.
5757
bButtonBackMCMQuickexit=true

‎docs/nexus-page.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,15 @@ Hold a gamepad button for a configurable duration to jump directly to a menu. Ea
5555
[size=4][b][color=#B8953E]Installation[/color][/b][/size]
5656
5757
[b]Mod manager (recommended):[/b]
58+
5859
[list=1]
5960
[*]Install the requirements above.
6061
[*]Install HoldFast via your mod manager.
6162
[*]Launch Skyrim via SKSE.
6263
[/list]
6364
6465
[b]Manual:[/b]
66+
6567
[list=1]
6668
[*]Install the requirements above.
6769
[*]Copy [font=Courier New]HoldFast.dll[/font] and [font=Courier New]HoldFast.ini[/font] to [font=Courier New]Data\SKSE\Plugins\[/font].
@@ -81,20 +83,21 @@ fHoldDuration=0.5
8183
; Long-press action for the Start (Menu) button. Short press performs the button's normal function.
8284
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
8385
sButtonStartAction=Map
84-
; Mod to open when sButtonStartAction=MCM. Leave as None to open the MCM mod list.
86+
; Mod to open when sButtonStartAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
8587
sButtonStartMCMModName=None
8688
; Close the journal automatically when leaving a MCM mod page via Start. Only applies when sButtonStartAction=MCM.
8789
bButtonStartMCMQuickexit=true
8890
; Long-press action for the Back (View) button. Short press performs the button's normal function.
8991
; Valid values: Map, System, Quests, Stats, Inventory, Magic, Favorites, TweenMenu, Wait, NewSave, QuickSave, Bestiary, CharacterSheet, MCM, None (case-insensitive)
9092
sButtonBackAction=System
91-
; Mod to open when sButtonBackAction=MCM. Leave as None to open the MCM mod list.
93+
; Mod to open when sButtonBackAction=MCM. Use the mod name as displayed in MCM (e.g. Better Third Person Selection) or leave as None to open the MCM mod list.
9294
sButtonBackMCMModName=None
9395
; Close the journal automatically when leaving a MCM mod page via Back. Only applies when sButtonBackAction=MCM.
9496
bButtonBackMCMQuickexit=true
9597
[/code]
9698
9799
[b]In-game settings (optional):[/b]
100+
98101
If SKSE Menu Framework v3 is installed, HoldFast adds a [font=Courier New]HoldFast/Settings[/font] page in its mod control panel.
99102
Use [b]Save to config[/b] to persist and apply changes, [b]Reload from config[/b] to discard staged edits and reload INI values, and [b]Reset to defaults[/b] to stage defaults ([font=Courier New]0.5[/font], [font=Courier New]Start=Map[/font], [font=Courier New]Back=System[/font]) until saved.
100103
@@ -119,6 +122,7 @@ Use [b]Save to config[/b] to persist and apply changes, [b]Reload from config[/b
119122
[/list]
120123
121124
Logs are written to:
125+
122126
[code]
123127
%USERPROFILE%\Documents\My Games\Skyrim Special Edition\SKSE\HoldFast.log
124128
[/code]

0 commit comments

Comments
 (0)