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/siapi prompts styles"

From PCGamingWiki, the wiki about fixing PC games
m (fixed document)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<includeonly>{{#switch:{{lc:{{{1|}}}}}
 
<includeonly>{{#switch:{{lc:{{{1|}}}}}
|siapi
 
 
|steam input api
 
|steam input api
 +
|siapi prompts
 +
|siapi button icon
 +
|steam input api prompts
 +
|siapi = <abbr title="This mode uses the button icon provided by Steam Input API.">SIAPI Button Icons</abbr>{{#vardefine:siapi prompts styles|{{#varexists:siapi prompts styles|{{#var:siapi prompts styles}},}}SIAPI button icons}}
 +
|in-game prompts
 +
|in-game button icon
 +
|external
 
|built-in
 
|built-in
|siapi = SIAPI Buttons{{#vardefine:SteamInput button modes|{{#varexists:SteamInput button modes|{{#var:SteamInput button modes}},}}SIAPI Buttons}}
+
|in-game = <abbr title="This mode uses the button icons that are already presented within the game.">In-Game Button Icons</abbr>{{#vardefine:siapi prompts styles{{#varexists:siapi prompts styles|{{#var:siapi prompts styles}},}}In-Game button icons}}
|in-game
 
|external
 
|button prompt query
 
|in-game = In-Game buttons{{#vardefine:SteamInput button modes|{{#varexists:SteamInput button modes|{{#var:SteamInput button modes}},}}In-Game Buttons}}
 
 
|unknown=
 
|unknown=
 
|#default=<div title="Error: '{{{1|}}}' not recognized" class="svg-icon svg-16 os-error"></div> {{#ifeq: {{NAMESPACE}} | | [[Category:Invalid template usage (Input)]] }}
 
|#default=<div title="Error: '{{{1|}}}' not recognized" class="svg-icon svg-16 os-error"></div> {{#ifeq: {{NAMESPACE}} | | [[Category:Invalid template usage (Input)]] }}
 
}}</includeonly><noinclude>{{Documentation}}</noinclude>
 
}}</includeonly><noinclude>{{Documentation}}</noinclude>

Latest revision as of 21:32, 1 June 2024

Documentation for the above template (sometimes hidden from view).
Recognized values
  • SIAPI Button Icons (Uses SIAPI's button icons to handle prompt detection)
    • alias: SIAPI, Steam Input API, Steam Input API Prompts, SIAPI Prompts, SIAPI Button Icon
  • In-Game Button Icons (Uses the game's built-in button icons to handle prompt detection)
    • alias: In-Game, In-Game Button Icon, In-Game Prompts, Built-In



Additional Notes while assigning the values:

Steam Input offers developers the ability to assign Button Prompts either by letting Steam handle the button prompts via their Button prompt image within Steam Client (the one you'll see on Steam Big Picture Mode/Steam Deck), or by letting SteamInput handle the game's own button prompt detection system. However: each game's method of implementation might be different on a per-game basis.

Here are our recommendations while testing and verifying games that take advantage of Steam Input's systems:

  • Unless the game explicitly opt-in to Steam Input, enabling Steam Input is strongly recommended.
  • Ensure the game is using either a Recommended Config, or a Template as the default.
  • Use either a PlayStation Controller, a Steam Controller, a Steam Deck and/or a Nintendo Switch controller. This should help determine if a game is detecting the Controller Type's prompts via SIAPI or In-Game.
    • Use the steam input prompts icons value and choose one [or more] of the supported controller's Prompt Legends to indicate Controller Type's Icons supported by the game.
    • Refer to {{Prompts}} for supported values.
  • Pay attention to the Icon style and its color scheme. The easiest way to determine is by rebinding to a non-standard controller layout [Note 1] and see if the game isn't using the In-Game's Button prompt style.
  • If a game only uses `In-Game Button Icons` and the game doesn't support a specific controller type icons; it'll use a closer equivalent to another Controller Type's prompt[Note 2].


For games that opted to use both SIAPI and In-Game button prompt styles simultaneously: You can assign both values and add a note for it. This is because a game might be using the in-game button icons as a primary detection system while SIAPI button icons are treated as a fallback in case the game doesn't have or recognize a Controller Type/Controller's non-standard buttons layout. (You can see it in action on games like Prey (2017) or Crypt of the NecroDancer.)



Reference:
  1. Example: Assigning to Trackpad/Touchpad Click, Paddle Buttons or Motion Sensor's Lean binding or Camera movement as a primary binding instead of secondary
  2. Example: Steam Controller and Steam Deck are similar to each other, Controller Type-wise. If Steam Deck button prompts aren't supported by the game: it will fallback to Steam Controller or Xbox button prompts.

    Alternatively: If a game doesn't provide Nintendo button prompts, it'll fallback to Xbox's button prompt icons (or it's equivalent) instead.