Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.


Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

Difference between revisions of "User:Al2009man/Sandbox/Template:Input/Documentation"

From PCGamingWiki, the wiki about fixing PC games
m (fixed link redirect)
 
(11 intermediate revisions by the same user not shown)
Line 11: Line 11:
  
 
;Arguments
 
;Arguments
* {{Code|key remap}}          - Whether the keyboard and mouse buttons are rebindable.  
+
* {{Code|key remap}}          - Whether the keyboard and mouse keybinds are rebindable.  
 
* {{Code|acceleration option}} - Whether the game uses mouse acceleration/smooting. Clarify which in the notes.  
 
* {{Code|acceleration option}} - Whether the game uses mouse acceleration/smooting. Clarify which in the notes.  
 
* {{Code|mouse sensitivity}}  - Whether the sensitivity of mouse movement can be adjusted. This only applies to games with some sort of camera control.
 
* {{Code|mouse sensitivity}}  - Whether the sensitivity of mouse movement can be adjusted. This only applies to games with some sort of camera control.
 
* {{Code|mouse menu}}          - Whether the mouse can be used to navigate the menu.  
 
* {{Code|mouse menu}}          - Whether the mouse can be used to navigate the menu.  
* {{Code|keyboard and mouse prompts}} - Whether the game support Keyboard and Mouse prompts
+
* {{Code|keyboard and mouse prompts}} - Whether the keyboard and mouse keybind or button prompts are available in-game.
 
* {{Code|invert mouse y-axis}} - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control.  
 
* {{Code|invert mouse y-axis}} - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control.  
* {{Code|touchscreen}}        - Whether the game is optimized for touchscreens.  
+
* {{Code|touchscreen}}        - Whether the game is optimized for touchscreens.
 
* {{Code|controller support}}  - Whether the game supports controllers.  
 
* {{Code|controller support}}  - Whether the game supports controllers.  
* {{Code|full controller}}    - Whether the game supports using just the controller, without requiring a Keyboard/Mouse Input Device. (Steam's "Big Picture Mode" features may also be supported)
+
* {{Code|full controller}}    - Whether the game can be fully navigated (e.g.: menus, game launchers) just by using a controller, without requiring a keyboard and mouse input device. Steam's "Big Picture Mode" features may also be supported.
 
* {{Code|controller motion sensors}} - Whenever the game supports the Controller's Motion Sensor functionality.
 
* {{Code|controller motion sensors}} - Whenever the game supports the Controller's Motion Sensor functionality.
* {{Code|controller motion sensors modes}} - What type of modes will the Controller's Motion Sensor functionality be used for.
+
* {{Code|controller motion sensors modes}} - What type of modes will the Controller's Motion Sensor function be used for (comma-separated).
** See {{User:Al2009man/Sandbox/Template:Input/Controller_motion_sensors_modes}} for acceptable values.
+
* {{Code|controller prompts}} - Whether the controller button prompts are available in-game.  
 +
** See {{User:Al2009man/Sandbox/Template:Input/controller motion sensors}} for acceptable values.
 
* {{Code|controller remap}}    - Whether the controller buttons are rebindable.
 
* {{Code|controller remap}}    - Whether the controller buttons are rebindable.
* {{Code|controller sensitivity}}  - Whether the sensitivity of the controller's analog stick inputs can be adjusted. This only applies to games with some sort of camera control.  
+
* {{Code|controller sensitivity}}  - Whether the sensitivity of the controller's analog stick, trackpads/touchpads, or motion sensors can be adjusted. This only applies to games with some sort of camera control.  
 
* {{Code|invert controller y-axis}} - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control.  
 
* {{Code|invert controller y-axis}} - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control.  
* {{Code|xinput controllers}}  - Whether the game supports XInput controllers.
+
* {{Code|xinput controllers}}  - Whether the game supports [[Glossary:Controller#Microsoft|Xbox]] or Input-compatible controllers.
 
* {{Code|xbox prompts}}        - Whether Xbox button prompts are available in-game.
 
* {{Code|xbox prompts}}        - Whether Xbox button prompts are available in-game.
* {{Code|impulse triggers}}    - Whether the game supports the [[Controller:Xbox Wireless Controller|Xbox Wireless Controller]] Impulse Triggers.
+
* {{Code|impulse triggers}}    - Whether the game supports [[Controller:Xbox Wireless Controller|Xbox Wireless Controller]]'s Impulse Triggers (also referred as Trigger Rumble).
* {{Code|playstation controllers}} - Whether the game supports [[Controller:DualShock 4|DualShock 4]] and/or [[Controller:DualSense|DualSense]] controllers.
+
* {{Code|playstation controllers}} - Whether the game supports [[Glossary:Controller#Sony|PlayStation controllers]] such as [[Controller:DualShock 4|DualShock 4]] and/or [[Controller:DualSense|DualSense]].
 
** {{Code|dualshock 4}} - The deprecated argument for this information.
 
** {{Code|dualshock 4}} - The deprecated argument for this information.
* {{Code|playstation controller models}} - What [[Template:Input/ps controllers|models and revisions]] of the DualShock 3, DualShock 4 or DualSense are supported (comma-separated).
+
* {{Code|playstation controller models}} - What PlayStation controller [[Template:Input/ps controllers|models and revisions]] are supported (comma-separated).
 
** See {{T|Input/ps controllers}} for acceptable values.
 
** See {{T|Input/ps controllers}} for acceptable values.
* {{Code|playstation prompts}} - Whether DualShock and/or DualSense button prompts are available in-game.
+
* {{Code|playstation prompts}} - Whether PlayStation button prompts are available in-game.
 
** {{Code|dualshock prompts}} - The deprecated argument for this information.
 
** {{Code|dualshock prompts}} - The deprecated argument for this information.
* {{Code|light bar support}}  - Whether the game supports the light bar.  
+
* {{Code|light bar support}}  - Whether the game supports the lightbar.  
* {{Code|dualsense adaptive trigger support}} - Whether the game supports the [[Controller:DualSense|DualSense]] adaptive triggers.
+
* {{Code|dualsense adaptive trigger support}} - Whether the game supports the [[Controller:DualSense|DualSense]]'s adaptive triggers.
* {{Code|dualsense haptics support}} - Whether the game supports [[Controller:DualSense|DualSense]] haptic feedback.
+
* {{Code|dualsense haptics support}} - Whether the game supports [[Controller:DualSense|DualSense]]'s haptic feedback.
* {{Code|playstation connection modes}} - What DualShock 4 and/or DualSense connection modes are supported by the game (comma-separated).
+
* {{Code|playstation connection modes}} - What PlayStation controller connection modes are supported by the game (comma-separated).
 
** See {{T|Input/ps connections}} for acceptable values.
 
** See {{T|Input/ps connections}} for acceptable values.
 
** {{Code|dualshock 4 modes}} - The deprecated argument for this information.
 
** {{Code|dualshock 4 modes}} - The deprecated argument for this information.
* {{Code|tracked motion controllers}} - [[Glossary:Controller|Tracked motion controllers]] support.  
+
* {{Code|tracked motion controllers}} - Whenever the game supports [[Glossary:Controller|Tracked motion controllers]] (i.e.: VR Controllers, Lightgun, etc.)
* {{Code|tracked motion prompts}} - Whether the game supports  [[Glossary:Controller|Tracked motion controllers]] button/gesture prompts.
+
* {{Code|tracked motion prompts}} - Whether the [[Glossary:Controller|motion controller]] button/gesture prompts are available in-game.
* {{Code|other controllers}}  - Whether the game supports generic/other controllers.
+
* {{Code|other controllers}}  - Whether the game supports generic/other controller types (e.g. DirectInput-compatible controllers, Nintendo Controllers, Racing Wheels, Flight Stick).
 
* {{Code|other button prompts}} - Whether generic/other button prompts are available in-game (comma-separated).  
 
* {{Code|other button prompts}} - Whether generic/other button prompts are available in-game (comma-separated).  
 
* {{Code|controller hotplug}}  - Whether the game supports controller hotplugging.
 
* {{Code|controller hotplug}}  - Whether the game supports controller hotplugging.
* {{Code|manual button prompt selection}}  - Whether the game allows users to change button prompt types regardless of controller types (or keyboard/mouse, if supported).
+
* {{Code|input prompt override}}  - Whether the game supports the ability to override the input prompts for any connected devices (e.g. locking button or keybind prompts regardless of Controller Type, Keyboard/Mouse or similar Input Devices).
* {{Code|haptic feedback}}    - Whether the game has haptic feedback.  
+
* {{Code|haptic feedback}}    - Whether the game supports haptic/rumble feedback.  
 
* {{Code|digital movement supported}}  - Whether the game is completely playable using digital movement controls (such as a D-pad, arcade joystick, or WASD keys), as opposed to analog.
 
* {{Code|digital movement supported}}  - Whether the game is completely playable using digital movement controls (such as a D-pad, arcade joystick, or WASD keys), as opposed to analog.
* {{Code|simultaneous input}}  - Whether supports using controller and keyboard/mouse inputs at the same time.  
+
* {{Code|simultaneous input}}  - Whether supports using controller and keyboard/mouse inputs simultaneously (also referred as Mixed Input).
 
* {{Code|steam input api}}    - Whether supports the [[Store:Steam#Steam_Input_API|Steam Input API]].  
 
* {{Code|steam input api}}    - Whether supports the [[Store:Steam#Steam_Input_API|Steam Input API]].  
* {{Code|steam hook input}}    - Whether Steam manages to hook input using Steam Virtual Gamepad / Legacy mode (only when not using Steam Input API).  
+
* {{Code|steam hook input}}    - Whenever Steam can hook the game's controller input system.  
 
* {{Code|steam input prompts}} - Whenever supports [[Controller:Steam_Controller#Games_with_Steam_button_prompts|Steam Input]]'s helper function to detect and provide the button prompts based on Controller Type (or closest equivalent).
 
* {{Code|steam input prompts}} - Whenever supports [[Controller:Steam_Controller#Games_with_Steam_button_prompts|Steam Input]]'s helper function to detect and provide the button prompts based on Controller Type (or closest equivalent).
* {{Code|steam input prompts modes}} - What type of [[Controller:Steam_Controller#Games_with_Steam_button_prompts|Steam Input Button prompt]] modes are supported by the game
+
* {{Code|steam input prompts modes}} - What type of [[Controller:Steam_Controller#Games_with_Steam_button_prompts|Steam Input Button prompt]] modes are supported by the game. (comma-separated)
** See {{User:Al2009man/Sandbox/Template:Input/SteamInput button modes}} for acceptable values.
+
** See {{User:Al2009man/Sandbox/Template:Input/siapi prompts}} for acceptable values.
 
* {{Code|steam deck prompts}} - Whether [[Steam Deck]]-specific button prompts are available in-game.  
 
* {{Code|steam deck prompts}} - Whether [[Steam Deck]]-specific button prompts are available in-game.  
 
* {{Code|steam controller prompts}} - Whether [[Controller:Steam Controller|Steam Controller]]-specific button prompts are available in-game.  
 
* {{Code|steam controller prompts}} - Whether [[Controller:Steam Controller|Steam Controller]]-specific button prompts are available in-game.  
* {{Code|steam input preset}} - Whether the game provides official [[Controller:Steam_Controller#Games_with_official_controller_bindings|Steam Input configuration presets]] by the developers.
+
* {{Code|steam input preset}} - Whether the game provides official [[Controller:Steam_Controller#Games_with_official_controller_bindings|Steam Input configuration presets]] by the developers.  
* {{Code|steam cursor detection}} - Whether Steam manages to differentiate between elements of the game where cursor is visible and where its hidden (only for Legacy mode).
+
* {{Code|steam cursor detection}} - Whether Steam manages to differentiate between elements of the game where the cursor is visible and where it's hidden (only for Legacy mode).
  
  
Line 85: Line 86:
 
|controller motion sensors modes =
 
|controller motion sensors modes =
 
|controller motion sensors notes =
 
|controller motion sensors notes =
 +
|controller prompts =
 +
|controller prompts notes =
 
|controller remap          =  
 
|controller remap          =  
 
|controller remap notes    =  
 
|controller remap notes    =  
Line 120: Line 123:
 
|controller hotplug        =  
 
|controller hotplug        =  
 
|controller hotplug notes  =  
 
|controller hotplug notes  =  
|manual button prompt selection =
+
|input prompt override =
|manual button prompt selection notes =
+
|input prompt override notes =
 
|haptic feedback          =  
 
|haptic feedback          =  
 
|haptic feedback notes    =  
 
|haptic feedback notes    =  

Latest revision as of 01:17, 29 April 2024

Description

This table is meant to contain all information relating to input settings and features. If a setting is hackable or requires additional notes, add the information below the table in a header like so:

=== [[Controller support]] ===
Fixbox here
...

and make note of it in the table in the following fashion See [[#Controller support|Controller support]]. Any smaller notes can and should be included directly in the table.

Below is a more thorough explanation of each of the possible arguments. Each can be appended with  notes to fill in the information in the Notes column.

Arguments
  • key remap - Whether the keyboard and mouse keybinds are rebindable.
  • acceleration option - Whether the game uses mouse acceleration/smooting. Clarify which in the notes.
  • mouse sensitivity - Whether the sensitivity of mouse movement can be adjusted. This only applies to games with some sort of camera control.
  • mouse menu - Whether the mouse can be used to navigate the menu.
  • keyboard and mouse prompts - Whether the keyboard and mouse keybind or button prompts are available in-game.
  • invert mouse y-axis - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control.
  • touchscreen - Whether the game is optimized for touchscreens.
  • controller support - Whether the game supports controllers.
  • full controller - Whether the game can be fully navigated (e.g.: menus, game launchers) just by using a controller, without requiring a keyboard and mouse input device. Steam's "Big Picture Mode" features may also be supported.
  • controller motion sensors - Whenever the game supports the Controller's Motion Sensor functionality.
  • controller motion sensors modes - What type of modes will the Controller's Motion Sensor function be used for (comma-separated).
  • controller prompts - Whether the controller button prompts are available in-game.
    • See
      for acceptable values.
  • controller remap - Whether the controller buttons are rebindable.
  • controller sensitivity - Whether the sensitivity of the controller's analog stick, trackpads/touchpads, or motion sensors can be adjusted. This only applies to games with some sort of camera control.
  • invert controller y-axis - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control.
  • xinput controllers - Whether the game supports Xbox or Input-compatible controllers.
  • xbox prompts - Whether Xbox button prompts are available in-game.
  • impulse triggers - Whether the game supports Xbox Wireless Controller's Impulse Triggers (also referred as Trigger Rumble).
  • playstation controllers - Whether the game supports PlayStation controllers such as DualShock 4 and/or DualSense.
    • dualshock 4 - The deprecated argument for this information.
  • playstation controller models - What PlayStation controller models and revisions are supported (comma-separated).
  • playstation prompts - Whether PlayStation button prompts are available in-game.
    • dualshock prompts - The deprecated argument for this information.
  • light bar support - Whether the game supports the lightbar.
  • dualsense adaptive trigger support - Whether the game supports the DualSense's adaptive triggers.
  • dualsense haptics support - Whether the game supports DualSense's haptic feedback.
  • playstation connection modes - What PlayStation controller connection modes are supported by the game (comma-separated).
    • See {{Input/ps connections}} for acceptable values.
    • dualshock 4 modes - The deprecated argument for this information.
  • tracked motion controllers - Whenever the game supports Tracked motion controllers (i.e.: VR Controllers, Lightgun, etc.)
  • tracked motion prompts - Whether the motion controller button/gesture prompts are available in-game.
  • other controllers - Whether the game supports generic/other controller types (e.g. DirectInput-compatible controllers, Nintendo Controllers, Racing Wheels, Flight Stick).
  • other button prompts - Whether generic/other button prompts are available in-game (comma-separated).
  • controller hotplug - Whether the game supports controller hotplugging.
  • input prompt override - Whether the game supports the ability to override the input prompts for any connected devices (e.g. locking button or keybind prompts regardless of Controller Type, Keyboard/Mouse or similar Input Devices).
  • haptic feedback - Whether the game supports haptic/rumble feedback.
  • digital movement supported - Whether the game is completely playable using digital movement controls (such as a D-pad, arcade joystick, or WASD keys), as opposed to analog.
  • simultaneous input - Whether supports using controller and keyboard/mouse inputs simultaneously (also referred as Mixed Input).
  • steam input api - Whether supports the Steam Input API.
  • steam hook input - Whenever Steam can hook the game's controller input system.
  • steam input prompts - Whenever supports Steam Input's helper function to detect and provide the button prompts based on Controller Type (or closest equivalent).
  • steam input prompts modes - What type of Steam Input Button prompt modes are supported by the game. (comma-separated)
    • See
      for acceptable values.
  • steam deck prompts - Whether Steam Deck-specific button prompts are available in-game.
  • steam controller prompts - Whether Steam Controller-specific button prompts are available in-game.
  • steam input preset - Whether the game provides official Steam Input configuration presets by the developers.
  • steam cursor detection - Whether Steam manages to differentiate between elements of the game where the cursor is visible and where it's hidden (only for Legacy mode).


Syntax
{{Input
|key remap                 = 
|key remap notes           = 
|acceleration option       = 
|acceleration option notes = 
|mouse sensitivity         = 
|mouse sensitivity notes   = 
|mouse menu                = 
|mouse menu notes          = 
|keyboard and mouse prompts =
|keyboard and mouse prompts notes =
|invert mouse y-axis       = 
|invert mouse y-axis notes = 
|touchscreen               = 
|touchscreen notes         = 
|controller support        = 
|controller support notes  = 
|full controller           = 
|full controller notes     = 
|controller motion sensors =
|controller motion sensors modes =
|controller motion sensors notes =
|controller prompts =
|controller prompts notes =
|controller remap          = 
|controller remap notes    = 
|controller sensitivity    = 
|controller sensitivity notes = 
|invert controller y-axis  = 
|invert controller y-axis notes = 
|xinput controllers        = 
|xinput controllers notes  = 
|xbox prompts              = 
|xbox prompts notes        = 
|impulse triggers          = 
|impulse triggers notes    = 
|playstation controllers   = 
|playstation controller models = 
|playstation controllers notes = 
|playstation prompts       = 
|playstation prompts notes = 
|light bar support         = 
|light bar support notes   = 
|dualsense adaptive trigger support =
|dualsense adaptive trigger support notes =
|dualsense haptics support  =
|dualsense haptics support notes =
|playstation connection modes = 
|playstation connection modes notes = 
|tracked motion controllers = 
|tracked motion controllers notes = 
|tracked motion prompts    = 
|tracked motion prompts notes = 
|other controllers         = 
|other controllers notes   = 
|other button prompts      = 
|other button prompts notes= 
|controller hotplug        = 
|controller hotplug notes  = 
|input prompt override  =
|input prompt override notes =
|haptic feedback           = 
|haptic feedback notes     = 
|digital movement supported = 
|digital movement supported notes = 
|simultaneous input        = 
|simultaneous input notes  = 
|steam input api           = 
|steam input api notes     = 
|steam hook input          = 
|steam hook input notes    = 
|steam input prompts =
|steam input prompts modes =
|steam input prompts notes =
|steam deck prompts  = 
|steam deck prompts notes = 
|steam controller prompts  = 
|steam controller prompts notes = 
|steam input presets =
|steam input preset notes = 
|steam cursor detection    = 
|steam cursor detection notes = 
}}
See also