translators
8,403
edits
Changes
Jump to navigation
Jump to search
Modding:Player Guide/Key Bindings (view source)
Revision as of 04:06, 19 October 2017
, 04:06, 19 October 2017initial draft with keyboard bindings
←[[Modding:Index|Index]]
Some mods let you edit key bindings. This page explains how to configure them.
==How to configure a mod's bindings==
# Install the mod ([[Modding:Player FAQs#Add or remove mods|see help]]).
# Run SMAPI at least once with the mod to let it generate its config file.
# Edit <tt>config.json</tt> in the mod's folder with a text editor.
# Find the key you want to change, and see the lookup below.
Note that some mods may not be configurable.
==Available bindings==
===Keyboard===
Keyboard bindings are supported by virtually all configurable mods.
; Common keys
: {| class="wikitable"
|-
! value
! description
|-
| <tt>A</tt> through <tt>Z</tt>
| The letter keys.
|-
| <tt>D0</tt> through <tt>D9</tt>
| The number keys.
|-
| <tt>Down</tt>, <tt>Left</tt>,<br /><tt>Right</tt>, <tt>Up</tt>
| The arrow keys.
|-
| <tt>F1</tt> through <tt>F24</tt>
| The function keys.
|-
| <tt>Apps</tt>
| The applications or menu ({{key|▤}}) key, typically located next to your right {{key|CTRL}} key.
|-
| <tt>Backspace</tt>
| The backspace ({{key|⌫}} or {{key|⟵}}) key.
|-
| <tt>CapsLock</tt>
| The {{key|CAPS LOCK}} or {{key|⇪}} key.
|-
| <tt>Enter</tt>
| The {{key|ENTER}} or {{key|↵}} key.
|-
| <tt>Escape</tt>
| The {{key|ESC}} key.
|-
| <tt>LeftAlt</tt>, <tt>RightAlt</tt>
| The {{key|ALT}} keys.
|-
| <tt>LeftControl</tt>, <tt>RightControl</tt>
| The {{key|CTRL}} key.
|-
| <tt>LeftShift</tt>, <tt>RightShift</tt>
| The {{key|SHIFT}} or {{key|⇧}} keys.
|-
| <tt>LeftWindows</tt>, <tt>RightWindows</tt>
| The Windows keys.
|-
| <tt>OemCloseBrackets</tt>
| The {{key|]}} key.
|-
| <tt>OemComma</tt>
| The {{key|,}} key.
|-
| <tt>OemMinus</tt>
| The {{key|-}} key.
|-
| <tt>OemOpenBrackets</tt>
| The {{key|[}} key.
|-
| <tt>OemPeriod</tt>
| The {{key|.}} key.
|-
| <tt>OemPipe</tt>
| The {{key||}} key.
|-
| <tt>OemPlus</tt>
| The {{key|+}} key.
|-
| <tt>OemQuestion</tt>
| The {{key|?}} key on a US standard keyboard.
|-
| <tt>OemQuotes</tt>
| The {{key|'}} or {{key|"}} key on a US standard keyboard.
|-
| <tt>OemSemicolon</tt>
| The {{key|;}} key on a US standard keyboard.
|-
| <tt>OemTilde</tt>
| The {{key|~}} key on a US standard keyboard.
|-
| <tt>Space</tt>
| The space bar.
|-
| <tt>Tab</tt>
| The {{key|TAB}} or {{key|
Subtract Subtract key
Tab TAB key
|}
; numeric pad
:{| class="wikitable"
|-
! value
! description
|-
| <tt>Numpad0</tt> through <tt>Numpad9</tt>
| The numpad number keys.
|-
| <tt>Add</tt>
| The {{key|+}} numpad key.
|-
| <tt>Divide</tt>
| The {{key|/}} numpad key.
|-
| <tt>Multiply</tt>
| The {{key|*}} numpad key.
|-
| <tt>NumLock</tt>
| The numeric lock, {{key|NUMLOCK}}, {{key|NUMLK}}, or {{key|NUM}} key.
|}
; control keys (above arrow keys)
:{| class="wikitable"
|-
! value
! description
|-
| <tt>Delete</tt>
| The {{key|DEL}} key.
|-
| <tt>End</tt>
| The {{key|END}} key.
|-
| <tt>Insert</tt>
| The {{key|INS}} key.
|-
| <tt>PageDown</tt>, <tt>PageUp</tt>
| The {{key|PAGE UP}} and {{key|PAGE DOWN}} keys.
|-
| <tt>Pause</tt>
| The {{key|PAUSE}} key.
|-
| <tt>PrintScreen</tt>
| The {{key|PRT SCR}} key.
|-
| <tt>Scroll</tt>
| The {{key|SCR LK}} key.
|}
; uncommon keys
:{| class="mw-collapsible mw-collapsed wikitable"
|-
!
|-
! value
! description
|-
| <tt>BrowserBack</tt>
| The browser back key.
|-
| <tt>BrowserFavorites</tt>
| The browser favorites key.
|-
| <tt>BrowserForward</tt>
| The browser forward key.
|-
| <tt>BrowserHome</tt>
| The browser start and home key.
|-
| <tt>BrowserRefresh</tt>
| The browser refresh key.
|-
| <tt>BrowserSearch</tt>
| The browser search key.
|-
| <tt>BrowserStop</tt>
| The browser stop key.
|-
| <tt>ChatPadGreen</tt>
| The green ChatPad key.
|-
| <tt>ChatPadOrange</tt>
| The orange ChatPad key.
|-
| <tt>Crsel</tt>
| The cursor select key.
|-
| <tt>Decimal</tt>
| The decimal key.
|-
| <tt>EraseEof</tt>
| The erase EOF key.
|-
| <tt>Execute</tt>
| The execute key.
|-
| <tt>Exsel</tt>
| The execute selection key.
|-
| <tt>Help</tt>
| The help key.
|-
| <tt>Home</tt>
| The home key.
|-
| <tt>ImeConvert</tt>
| The IME convert key.
|-
| <tt>ImeNoConvert</tt>
| The IME no-convert key.
|-
| <tt>Kana</tt>
| The Kana key on Japanese keyboards.
|-
| <tt>Kanji</tt>
| The Kanji key on Japanese keyboards.
|-
| <tt>LaunchApplication1</tt>
| The Start Application 1 key.
|-
| <tt>LaunchApplication2</tt>
| The Start Application 2 key.
|-
| <tt>LaunchMail</tt>
| The Start Mail key.
|-
| <tt>MediaNextTrack</tt>
| The Next Track key.
|-
| <tt>MediaPlayPause</tt>
| The Play/Pause Media key.
|-
| <tt>MediaPreviousTrack</tt>
| The Previous Track key.
|-
| <tt>MediaStop</tt>
| The Stop Media key.
|-
| <tt>Oem8</tt>
| Varies by keyboard.
|-
| <tt>OemAuto</tt>
| OEM Auto key.
|-
| <tt>OemBackslash</tt>
| The The OEM angle bracket or backslash key on the RT 102 key keyboard.
|-
| <tt>OemClear</tt>
| The OEM clear key.
|-
| <tt>OemCopy</tt>
| The OEM copy key.
|-
| <tt>OemEnlW</tt>
| The OEM Enlarge Window key.
|-
| <tt>PA1</tt>
| The PA1 key.
|-
| <tt>Play</tt>
| The play key.
|-
| <tt>Print</tt>
| The {{key|PRINT}} key.
|-
| <tt>ProcessKey</tt>
| The IME process key.
|-
| <tt>Select</tt>
| The select key.
|-
| <tt>SelectMedia</tt>
| The select media key.
|-
| <tt>Separator</tt>
| The separator key.
|-
| <tt>Sleep</tt>
| The computer sleep key.
|-
| <tt>VolumeDown</tt>, <tt>VolumeUp</tt>
| The volume down/up keys.
|-
| <tt>VolumeMute</tt>
| The volume mute keys.
|-
| <tt>Zoom</tt>
| The zoom key.
|}
==References==
* These constants are defined by SMAPI's <tt>SButton</tt> enum, which unifies XNA's [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.buttons.aspx <tt>Buttons</tt>], [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.keys.aspx <tt>Keys</tt>], and [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.mousestate.aspx <tt>MouseState</tt>].
<!--[[Category:Modding]]-->
Some mods let you edit key bindings. This page explains how to configure them.
==How to configure a mod's bindings==
# Install the mod ([[Modding:Player FAQs#Add or remove mods|see help]]).
# Run SMAPI at least once with the mod to let it generate its config file.
# Edit <tt>config.json</tt> in the mod's folder with a text editor.
# Find the key you want to change, and see the lookup below.
Note that some mods may not be configurable.
==Available bindings==
===Keyboard===
Keyboard bindings are supported by virtually all configurable mods.
; Common keys
: {| class="wikitable"
|-
! value
! description
|-
| <tt>A</tt> through <tt>Z</tt>
| The letter keys.
|-
| <tt>D0</tt> through <tt>D9</tt>
| The number keys.
|-
| <tt>Down</tt>, <tt>Left</tt>,<br /><tt>Right</tt>, <tt>Up</tt>
| The arrow keys.
|-
| <tt>F1</tt> through <tt>F24</tt>
| The function keys.
|-
| <tt>Apps</tt>
| The applications or menu ({{key|▤}}) key, typically located next to your right {{key|CTRL}} key.
|-
| <tt>Backspace</tt>
| The backspace ({{key|⌫}} or {{key|⟵}}) key.
|-
| <tt>CapsLock</tt>
| The {{key|CAPS LOCK}} or {{key|⇪}} key.
|-
| <tt>Enter</tt>
| The {{key|ENTER}} or {{key|↵}} key.
|-
| <tt>Escape</tt>
| The {{key|ESC}} key.
|-
| <tt>LeftAlt</tt>, <tt>RightAlt</tt>
| The {{key|ALT}} keys.
|-
| <tt>LeftControl</tt>, <tt>RightControl</tt>
| The {{key|CTRL}} key.
|-
| <tt>LeftShift</tt>, <tt>RightShift</tt>
| The {{key|SHIFT}} or {{key|⇧}} keys.
|-
| <tt>LeftWindows</tt>, <tt>RightWindows</tt>
| The Windows keys.
|-
| <tt>OemCloseBrackets</tt>
| The {{key|]}} key.
|-
| <tt>OemComma</tt>
| The {{key|,}} key.
|-
| <tt>OemMinus</tt>
| The {{key|-}} key.
|-
| <tt>OemOpenBrackets</tt>
| The {{key|[}} key.
|-
| <tt>OemPeriod</tt>
| The {{key|.}} key.
|-
| <tt>OemPipe</tt>
| The {{key||}} key.
|-
| <tt>OemPlus</tt>
| The {{key|+}} key.
|-
| <tt>OemQuestion</tt>
| The {{key|?}} key on a US standard keyboard.
|-
| <tt>OemQuotes</tt>
| The {{key|'}} or {{key|"}} key on a US standard keyboard.
|-
| <tt>OemSemicolon</tt>
| The {{key|;}} key on a US standard keyboard.
|-
| <tt>OemTilde</tt>
| The {{key|~}} key on a US standard keyboard.
|-
| <tt>Space</tt>
| The space bar.
|-
| <tt>Tab</tt>
| The {{key|TAB}} or {{key|
Subtract Subtract key
Tab TAB key
|}
; numeric pad
:{| class="wikitable"
|-
! value
! description
|-
| <tt>Numpad0</tt> through <tt>Numpad9</tt>
| The numpad number keys.
|-
| <tt>Add</tt>
| The {{key|+}} numpad key.
|-
| <tt>Divide</tt>
| The {{key|/}} numpad key.
|-
| <tt>Multiply</tt>
| The {{key|*}} numpad key.
|-
| <tt>NumLock</tt>
| The numeric lock, {{key|NUMLOCK}}, {{key|NUMLK}}, or {{key|NUM}} key.
|}
; control keys (above arrow keys)
:{| class="wikitable"
|-
! value
! description
|-
| <tt>Delete</tt>
| The {{key|DEL}} key.
|-
| <tt>End</tt>
| The {{key|END}} key.
|-
| <tt>Insert</tt>
| The {{key|INS}} key.
|-
| <tt>PageDown</tt>, <tt>PageUp</tt>
| The {{key|PAGE UP}} and {{key|PAGE DOWN}} keys.
|-
| <tt>Pause</tt>
| The {{key|PAUSE}} key.
|-
| <tt>PrintScreen</tt>
| The {{key|PRT SCR}} key.
|-
| <tt>Scroll</tt>
| The {{key|SCR LK}} key.
|}
; uncommon keys
:{| class="mw-collapsible mw-collapsed wikitable"
|-
!
|-
! value
! description
|-
| <tt>BrowserBack</tt>
| The browser back key.
|-
| <tt>BrowserFavorites</tt>
| The browser favorites key.
|-
| <tt>BrowserForward</tt>
| The browser forward key.
|-
| <tt>BrowserHome</tt>
| The browser start and home key.
|-
| <tt>BrowserRefresh</tt>
| The browser refresh key.
|-
| <tt>BrowserSearch</tt>
| The browser search key.
|-
| <tt>BrowserStop</tt>
| The browser stop key.
|-
| <tt>ChatPadGreen</tt>
| The green ChatPad key.
|-
| <tt>ChatPadOrange</tt>
| The orange ChatPad key.
|-
| <tt>Crsel</tt>
| The cursor select key.
|-
| <tt>Decimal</tt>
| The decimal key.
|-
| <tt>EraseEof</tt>
| The erase EOF key.
|-
| <tt>Execute</tt>
| The execute key.
|-
| <tt>Exsel</tt>
| The execute selection key.
|-
| <tt>Help</tt>
| The help key.
|-
| <tt>Home</tt>
| The home key.
|-
| <tt>ImeConvert</tt>
| The IME convert key.
|-
| <tt>ImeNoConvert</tt>
| The IME no-convert key.
|-
| <tt>Kana</tt>
| The Kana key on Japanese keyboards.
|-
| <tt>Kanji</tt>
| The Kanji key on Japanese keyboards.
|-
| <tt>LaunchApplication1</tt>
| The Start Application 1 key.
|-
| <tt>LaunchApplication2</tt>
| The Start Application 2 key.
|-
| <tt>LaunchMail</tt>
| The Start Mail key.
|-
| <tt>MediaNextTrack</tt>
| The Next Track key.
|-
| <tt>MediaPlayPause</tt>
| The Play/Pause Media key.
|-
| <tt>MediaPreviousTrack</tt>
| The Previous Track key.
|-
| <tt>MediaStop</tt>
| The Stop Media key.
|-
| <tt>Oem8</tt>
| Varies by keyboard.
|-
| <tt>OemAuto</tt>
| OEM Auto key.
|-
| <tt>OemBackslash</tt>
| The The OEM angle bracket or backslash key on the RT 102 key keyboard.
|-
| <tt>OemClear</tt>
| The OEM clear key.
|-
| <tt>OemCopy</tt>
| The OEM copy key.
|-
| <tt>OemEnlW</tt>
| The OEM Enlarge Window key.
|-
| <tt>PA1</tt>
| The PA1 key.
|-
| <tt>Play</tt>
| The play key.
|-
| <tt>Print</tt>
| The {{key|PRINT}} key.
|-
| <tt>ProcessKey</tt>
| The IME process key.
|-
| <tt>Select</tt>
| The select key.
|-
| <tt>SelectMedia</tt>
| The select media key.
|-
| <tt>Separator</tt>
| The separator key.
|-
| <tt>Sleep</tt>
| The computer sleep key.
|-
| <tt>VolumeDown</tt>, <tt>VolumeUp</tt>
| The volume down/up keys.
|-
| <tt>VolumeMute</tt>
| The volume mute keys.
|-
| <tt>Zoom</tt>
| The zoom key.
|}
==References==
* These constants are defined by SMAPI's <tt>SButton</tt> enum, which unifies XNA's [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.buttons.aspx <tt>Buttons</tt>], [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.keys.aspx <tt>Keys</tt>], and [https://msdn.microsoft.com/en-us/library/microsoft.xna.framework.input.mousestate.aspx <tt>MouseState</tt>].
<!--[[Category:Modding]]-->