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 "Template:Input/Documentation"

From PCGamingWiki, the wiki about fixing PC games
m (fixed placeholder spacing)
m (connection modes)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
;Description
 
;Description
This settings table is meant to contain all information relating to input settings. If a setting is {{Code|hackable}} or requires additional notes, add the information below the table in a header like so:
+
This table is meant to contain all information relating to input settings and features. If a setting is {{Code|hackable}} or requires additional notes, add the information below the table in a header like so:
 
<pre><nowiki>
 
<pre><nowiki>
 
=== [[Controller support]] ===
 
=== [[Controller support]] ===
Line 11: Line 11:
  
 
;Arguments
 
;Arguments
* {{Code|key remap}}          - Whether the keyboard and mouse buttons are rebindable. Defines [[Property:Key remapping]];
+
* {{Code|key remap}}          - Whether the keyboard and mouse buttons are rebindable.  
* {{Code|acceleration option}} - Whether the game uses mouse acceleration/smooting. Clarify which in the notes. Defines [[Property:Mouse acceleration]];
+
* {{Code|acceleration option}} - Whether the game uses mouse acceleration/smooting. Clarify which in the notes.  
* {{Code|mouse sensitivity}}  - Defines [[Property:Mouse sensitivity]];
+
* {{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. Defines [[Property:Mouse input in menus]];
+
* {{Code|mouse menu}}          - Whether the mouse can be used to navigate the menu.  
* {{Code|invert mouse y-axis}} - Whether the mouse Y-axis can be inverted. This only applies to games with some sort of camera control. Defines [[Property:Mouse Y-axis inversion]];
+
* {{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. Defines [[Property:Touchscreen optimised]].
+
* {{Code|touchscreen}}        - Whether the game is optimized for touchscreens.  
* {{Code|controller support}}  - Whether the game supports controllers. Defines [[Property:Controller support]];
+
* {{Code|controller support}}  - Whether the game supports controllers.  
* {{Code|full controller}}    - Whether the game supports using just the controller, aka "Big Picture". Defines [[Property:Full controller support]];
+
* {{Code|full controller}}    - Whether the game supports using just the controller, aka "Big Picture".  
* {{Code|controller remap}}    - Whether the controller buttons are rebindable. [[Property:Controller remapping]];
+
* {{Code|controller remap}}    - Whether the controller buttons are rebindable.
* {{Code|controller sensitivity}}  - Defines [[Property:Controller sensitivity]];
+
* {{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|invert controller y-axis}} - Whether the controller Y-axis can be inverted. This only applies to games with some sort of camera control. Defines [[Property:Controller Y-axis inversion]];
+
* {{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 XInput 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 One Controller|Xbox One Controller]] Impulse Triggers.
+
* {{Code|impulse triggers}}    - Whether the game supports the [[Controller:Xbox Wireless Controller|Xbox Wireless Controller]] Impulse Triggers.
* {{Code|dualshock 4}}         - Whether the game supports [[Controller:DualShock 4|DualShock 4]] controllers.
+
* {{Code|playstation controllers}} - Whether the game supports [[Controller:DualShock 4|DualShock 4]] and/or [[Controller:DualSense|DualSense]] controllers.
* {{Code|dualshock prompts}}   - Whether DualShock button prompts are available in-game.
+
** {{Code|dualshock 4}} - The deprecated argument for this information.
* {{Code|light bar support}}  - Whether the game supports the [[Controller:DualShock 4|DualShock 4 light bar]]. Defines [[Property:DualShock 4 light bar support]].
+
* {{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|dualshock 4 modes}}   - What DualShock 4 connection modes are supported by the game (comma-separated).
+
** See {{T|Input/ps controllers}} for acceptable values.
* {{Code|tracked motion controllers}} - [[Glossary:Controller|Tracked motion controllers]] support. Defines [[Property:Tracked motion controllers]].
+
* {{Code|playstation prompts}} - Whether DualShock and/or DualSense button prompts are available in-game.
 +
** {{Code|dualshock prompts}} - The deprecated argument for this information.
 +
* {{Code|light bar support}}  - Whether the game supports the light bar.
 +
* {{Code|dualsense adaptive trigger support}} - Whether the game supports the [[Controller:DualSense|DualSense]] adaptive triggers.
 +
* {{Code|dualsense haptics support}} - Whether the game supports [[Controller:DualSense|DualSense]] haptic feedback.
 +
* {{Code|playstation connection modes}} - What DualShock 4 and/or DualSense connection modes are supported by the game (comma-separated).
 +
** See {{T|Input/ps connections}} for acceptable values.
 +
** {{Code|dualshock 4 modes}} - The deprecated argument for this information.
 +
* {{Code|tracked motion controllers}} - [[Glossary:Controller|Tracked motion controllers]] support.  
 
* {{Code|tracked motion prompts}} - Whether the game supports  [[Glossary:Controller|Tracked motion controllers]] button/gesture prompts.
 
* {{Code|tracked motion prompts}} - Whether the game supports  [[Glossary:Controller|Tracked motion controllers]] button/gesture prompts.
 
* {{Code|other controllers}}  - Whether the game supports generic/other controllers.
 
* {{Code|other controllers}}  - Whether the game supports generic/other controllers.
* {{Code|other button prompts}}- Whether generic/other button prompts are available in-game (comma-separated). Defines [[Property:Buttons prompts]].
+
* {{Code|other button prompts}} - Whether generic/other button prompts are available in-game (comma-separated).  
* {{Code|controller hotplug}}  - Whether the game supports controller hotplugging. Defines [[Property:Controller hotplugging‎]].
+
* {{Code|controller hotplug}}  - Whether the game supports controller hotplugging.  
* {{Code|haptic feedback}}    - Whether the game has haptic feedback. Defines [[Property:Controller haptic feedback‎]].
+
* {{Code|haptic feedback}}    - Whether the game has haptic feedback.  
* {{Code|simultaneous input}}  - Whether supports using controller and keyboard/mouse inputs at the same time. Defines [[Property:Simultaneous input‎]].
+
* {{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|steam input api}}    - Whether supports the [[Controller:Steam Controller|Steam Input API]]. Defines [[Property:Steam Input API support‎]].
+
* {{Code|simultaneous input}}  - Whether supports using controller and keyboard/mouse inputs at the same time.  
* {{Code|steam hook input}}    - Whether Steam manages to hook input using legacy mode (only when not using Steam Input API). Defines [[Property:Steam hook input]].
+
* {{Code|steam input api}}    - Whether supports the [[Controller:Steam Controller|Steam Input API]].  
* {{Code|steam input presets}} - Whether the game supports official [[Controller:Steam Controller|Steam Input presets]]. Defines [[Property:Steam Input presets]].
+
* {{Code|steam hook input}}    - Whether Steam manages to hook input using legacy mode (only when not using Steam Input API).  
* {{Code|steam controller prompts}} - Whether [[Controller:Steam Controller|Steam Controller]] button prompts are available in-game. Defines [[Property:Steam Controller prompts]].
+
* {{Code|steam input presets}} - Whether the game supports official [[Controller:Steam Controller|Steam Input presets]].  
* {{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). Defines [[Property:Steam Input mouse cursor detection]].
+
* {{Code|steam controller prompts}} - Whether [[Controller:Steam Controller|Steam Controller]] button prompts are available in-game.  
 +
* {{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).  
  
  
 
;Syntax
 
;Syntax
 
<pre><nowiki>
 
<pre><nowiki>
{{Input settings
+
{{Input
 
|key remap                =  
 
|key remap                =  
 
|key remap notes          =  
 
|key remap notes          =  
Line 65: Line 74:
 
|controller remap notes    =  
 
|controller remap notes    =  
 
|controller sensitivity    =  
 
|controller sensitivity    =  
|controller sensitivity notes=  
+
|controller sensitivity notes =  
 
|invert controller y-axis  =  
 
|invert controller y-axis  =  
|invert controller y-axis notes=  
+
|invert controller y-axis notes =  
 
|xinput controllers        =  
 
|xinput controllers        =  
 
|xinput controllers notes  =  
 
|xinput controllers notes  =  
Line 74: Line 83:
 
|impulse triggers          =  
 
|impulse triggers          =  
 
|impulse triggers notes    =  
 
|impulse triggers notes    =  
|dualshock 4              =  
+
|playstation controllers  =  
|dualshock 4 notes         =  
+
|playstation controller models =
|dualshock prompts         =  
+
|playstation controllers notes =  
|dualshock prompts notes   =  
+
|playstation prompts       =  
 +
|playstation prompts notes =  
 
|light bar support        =  
 
|light bar support        =  
 
|light bar support notes  =  
 
|light bar support notes  =  
|dualshock 4 modes         =  
+
|dualsense adaptive trigger support =
|dualshock 4 modes notes   =  
+
|dualsense adaptive trigger support notes =
|tracked motion controllers=  
+
|dualsense haptics support  =
 +
|dualsense haptics support notes =
 +
|playstation connection modes =  
 +
|playstation connection modes notes =  
 +
|tracked motion controllers =  
 
|tracked motion controllers notes =  
 
|tracked motion controllers notes =  
 
|tracked motion prompts    =  
 
|tracked motion prompts    =  
Line 94: Line 108:
 
|haptic feedback          =  
 
|haptic feedback          =  
 
|haptic feedback notes    =  
 
|haptic feedback notes    =  
 +
|digital movement supported =
 +
|digital movement supported notes=
 
|simultaneous input        =  
 
|simultaneous input        =  
 
|simultaneous input notes  =  
 
|simultaneous input notes  =  

Latest revision as of 08:14, 10 February 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 buttons 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.
  • 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 supports using just the controller, aka "Big Picture".
  • controller remap - Whether the controller buttons are rebindable.
  • 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.
  • 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 XInput controllers.
  • xbox prompts - Whether Xbox button prompts are available in-game.
  • impulse triggers - Whether the game supports the Xbox Wireless Controller Impulse Triggers.
  • playstation controllers - Whether the game supports DualShock 4 and/or DualSense controllers.
    • dualshock 4 - The deprecated argument for this information.
  • playstation controller models - What models and revisions of the DualShock 3, DualShock 4 or DualSense are supported (comma-separated).
  • playstation prompts - Whether DualShock and/or DualSense button prompts are available in-game.
    • dualshock prompts - The deprecated argument for this information.
  • light bar support - Whether the game supports the light bar.
  • dualsense adaptive trigger support - Whether the game supports the DualSense adaptive triggers.
  • dualsense haptics support - Whether the game supports DualSense haptic feedback.
  • playstation connection modes - What DualShock 4 and/or DualSense 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 - Tracked motion controllers support.
  • tracked motion prompts - Whether the game supports Tracked motion controllers button/gesture prompts.
  • other controllers - Whether the game supports generic/other controllers.
  • other button prompts - Whether generic/other button prompts are available in-game (comma-separated).
  • controller hotplug - Whether the game supports controller hotplugging.
  • haptic feedback - Whether the game has haptic 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 at the same time.
  • steam input api - Whether supports the Steam Input API.
  • steam hook input - Whether Steam manages to hook input using legacy mode (only when not using Steam Input API).
  • steam input presets - Whether the game supports official Steam Input presets.
  • steam controller prompts - Whether Steam Controller button prompts are available in-game.
  • 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).


Syntax
{{Input
|key remap                 = 
|key remap notes           = 
|acceleration option       = 
|acceleration option notes = 
|mouse sensitivity         = 
|mouse sensitivity notes   = 
|mouse menu                = 
|mouse menu notes          = 
|invert mouse y-axis       = 
|invert mouse y-axis notes = 
|touchscreen               = 
|touchscreen notes         = 
|controller support        = 
|controller support notes  = 
|full controller           = 
|full controller 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  = 
|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 presets       = 
|steam input presets notes = 
|steam controller prompts  = 
|steam controller prompts notes = 
|steam cursor detection    = 
|steam cursor detection notes = 
}}
See also