Input
Last updated
Toolkit for Steamworks
Last updated
Steam Input allows you to define "actions" for your game, which can be mapped and bound by the Steam client (outside your game), enabling any controller the player may have to work.
In practice, Steam Input is very much like Unity's "new" Input System and 3rd party Unity assets such as Rewired. Steam Input is not a requirement to publish your game on Steam or to achieve Steam Deck verification.
Steam Input cannot be used for Keyboard and Mouse bindings in as it was designed specifically for use with controllers that are being mapped by the Steam client.
First you will need to define the actions your game has, this is done via an In-Game Action file which is a JSON-style file located at the root of the project. See https://partner.steamgames.com/doc/features/steam_controller/iga_file for more information.
This is how you define what action sets, layers and actions your game has and how they are used (loosely). Using this Steam's controller binding system can be used to map various controls to your actions and your game can thus be blissfully unaware of what IO device is driving the game.
We consider these tools a legacy, but will maintain them through this version.
An action set is simply a container of layers and actions. For example, you might have 1 set of actions you use in your menu and another you use in gameplay, so you might have an action set menuActions and another gameActions .
An action set layer is a mask laid over the top of an action set. They are defined as a member of the action set and simply modify the set of actions activated by the set. An example might be a layer that adds extra mappings such as a sniper mode when a valid weapon is equipped or vehicle-type specific actions such as gas, brake, throttle up/down, etc.
An action is ... well, the action the player has requested, such as jump, walk, shoot, etc. These are defined as members of an action set or action set layer and can specify what kind of action they are, e.g. analogue or digital, and if analogue, what mode, e.g. stick, absolute mouse, etc.
Once you have created your In-Game Action file, for more information on that, read here https://partner.steamgames.com/doc/features/steam_controller/iga_file
Steam Input actions, sets and layers can be referenced in your Steam Settings. Simply expand the Artifacts section and add each action, layer and set; this will create Scriptable Object representations for each under your Steam Settings object in your Asset folder. You can then reference these objects in your other scripts to detect when the action has been triggered and with what values.
You can toggle your Action types by simply clicking the AI/DI button
AI represents an "Analog Input"
DI represents a "Digital Input"
Before you can use Steam Input you need to enable it. We have created a tool for you that will handle this ... see Steam Input Manager for details. Alternatively, you can do this yourself with just a few lines of code if you prefer.
Input Manager only does 3 things for you
Initialize and Dispose of the Input system
To do this, you need to call API.Input.Client.RunFrame on start. In UnityEditor, you should also call Application.OpenURL($"steam://forceinputappid/{SteamSettings.ApplicationId}"); to force the Steam client to use your app's input settings
And when you're done, call Application.OpenURL("steam://forceinputappid/0");
Get the list of controllers, e.g.
controllers = API.Input.Client.ConnectedControllers; You'll need these for step 3
Update all actions for all controllers, e.g.
foreach over each controller and call: SteamSettings.Client.UpdateAllActions(controller); on it.
For a functional coded example, simply review the source code of SteamInputManager.cs
When you simply want to check the value of an input action. Let's assume you have created a reference to your desired InputAction in your class object such as.
Then you can read the state of that action for a given controller
This of course, assumes you want to read data from the first controller and that you have made sure there is a controller. What this returns is an InputActionData object, which can be used to understand the current state of the action.
We created InputAction as a type of Game Event. So this means you can register and listen for changes on each input action from anywhere. We have tools like the Input Action Event that let you set this up easily in Unity Editor's Inspector.
You can also register for events in the script just as easily
This would assume that HandleActionEvent looked like this
