Skip to content

Commit 52156fe

Browse files
SteamDB-TrackerSteamDB-Tracker
committed
4 files | getting_started_for_devs.html, workshop_uploaded_configs.html, links.json, dailydeal.html
1 parent 3e5bcb5 commit 52156fe

File tree

4 files changed

+191
-109
lines changed

4 files changed

+191
-109
lines changed

‎docs/features/steam_controller/getting_started_for_devs.html‎

Lines changed: 39 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -425,8 +425,9 @@ <h2 class="bb_subsection"><a name="13"></a>Step 1.2 - Titles &amp; Descriptions<
425425
is setup for Southpaw users." "Action_Jump" "Jump" "Action_Camera" "Camera" } }
426426
</div>
427427
<br />
428-
When you publish a configuration (see <a href="#publishing">Step 4 - Publishing</a>), you'll be able
429-
to select which of these localized titles and descriptions you want to use.
428+
When you publish a configuration (see
429+
<a href="#publishing">Step 4 - Setting Partner Site Settings</a>), you'll be able to select which of
430+
these localized titles and descriptions you want to use.
430431
<h2 class="bb_section"><a name="14"></a>Step 2 - Creating a Default Configuration</h2>
431432
<br />
432433
Once you've created your IGA file, and ensured it's in the right directory &amp; named to match your
@@ -664,34 +665,18 @@ <h3>Poll continuously!</h3>
664665
automatically update to match the new origins.
665666
</div>
666667
</div>
667-
<h2 class="bb_section"><a name="publishing"></a>Step 4 - Publishing</h2>
668+
<h2 class="bb_section"><a name="publishing"></a>Step 4 - Setting Partner Site Settings</h2>
668669
<br />
669-
Once your game is working with the controller, you're ready to publish. You'll need to release your
670-
new game update and make your configuration the official one. Official configurations are
671-
automatically loaded when a player launches your game for the first time. This allows users to
672-
simply fire up your game and play without needing to go into the configuration screen at all.<br />
670+
You've now setup Steam Input API to work for your local development machine and we need to set some
671+
partner site settings in order to publish the configuration and settings for normal players.<br />
673672
<br />
674673
Here's the recommended process:
675-
<h2 class="bb_subsection"><a name="19"></a>Step 4.1 - Update your game</h2>
676-
<ul>
677-
<li>Update your Steam depot with your new version of the game</li>
678-
</ul>
679-
<h2 class="bb_subsection"><a name="20"></a>Step 4.2 - Publish your configuration</h2>
680-
<ul>
681-
<li>
682-
Run Steam in Big Picture mode and navigate to the default configuration you created in the
683-
controller configuration.<br />
684-
</li>
685-
<li>Hit the (Y) button, or click the "Save As" button at the bottom of the screen.<br /></li>
686-
<li>
687-
Select the desired localized title &amp; description in the popup, change it to a PUBLIC
688-
profile, and click the PUBLISH button.<br />
689-
</li>
690-
<li>
691-
You will get a confirmation, and the file ID of the public configuration. Copy/save the ID.
692-
</li>
693-
</ul>
694-
<h2 class="bb_subsection"><a name="21"></a>Step 4.3 - Make the configuration official</h2>
674+
<h2 class="bb_subsection">
675+
<a name="19"></a>Step 4.1 - Convert your local configuration into an Action Manifest File
676+
</h2>
677+
Steps for setting up an Action Manfest file can be found
678+
<a href="/doc/features/steam_controller/action_manifest_file">here</a>
679+
<h2 class="bb_subsection"><a name="20"></a>Step 4.2 - Make the configuration official</h2>
695680
<ul>
696681
<li>Open up your game's page on the Steamworks partner website.<br /></li>
697682
<li>
@@ -705,63 +690,34 @@ <h2 class="bb_subsection"><a name="21"></a>Step 4.3 - Make the configuration off
705690
<br />
706691
</li>
707692
<li>
708-
Scroll to the section called "Steam Input Template". Select the "Custom Configuration"
709-
option in the dropdown. (If you were not planning on adding native support and just want to
710-
select from common legacy mode presets, here is where you would do so).<br />
711-
<br />
712-
<img
713-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_custom_config.png"
714-
alt="steamworks_steam_input_custom_config.png"
715-
title="steamworks_steam_input_custom_config.png"
716-
/><br />
717-
<br />
718-
And from the selection below, select "Add Custom Configuration."<br />
693+
Scroll to the section called "Steam Input Template". Select the "Custom Configuration
694+
(Bundled with Game)" option in the dropdown. (If you were not planning on adding native
695+
support and just want to select from common legacy mode presets, here is where you would do
696+
so).<br />
719697
<br />
720698
<img
721-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_controller_custom2.png"
722-
alt="steamworks_steam_controller_custom2.png"
723-
title="steamworks_steam_controller_custom2.png"
699+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/set_game_bundled.png"
700+
alt="set_game_bundled.png"
701+
title="set_game_bundled.png"
724702
/><br />
725703
<br />
726-
</li>
727-
<li>
728-
Paste the file ID of your public configuration into the box, and click the OK button.<br />
704+
And in the text box below, input the relative path to the Action Manifest file VDF inside of
705+
your game install folder<br />
729706
<br />
730707
<img
731-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_controller_custom3.png"
732-
alt="steamworks_steam_controller_custom3.png"
733-
title="steamworks_steam_controller_custom3.png"
734-
/><br />
735-
<br />
708+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/setup_path.png"
709+
alt="setup_path.png"
710+
title="setup_path.png"
711+
/>
712+
<div class="bb_callout">
713+
<div>
714+
Note: if your game is multi-platform, make sure the path is consistent across the
715+
different versions of your game
716+
</div>
717+
</div>
736718
</li>
737-
<li>Publish your app changes in the partner site as usual.</li>
738719
</ul>
739-
<br />
740-
If you'd like, you can also specify multiple official configurations for your game. You may want to
741-
create an official "Southpaw" (left-handed) mode, for example.<br />
742-
<br />
743-
To do this, simply create multiple configurations and publish them each via step 4.2. Then, in step
744-
4.3, paste all the file IDs for your configurations into the box, separated by the comma character
745-
(,) characters. The first one on the list will be considered the highest priority, and will be
746-
picked by default for new players. Don't forget to make
747-
<a href="/documentation/steamcontroller#step12" target="_blank" rel="noreferrer"
748-
>Titles &amp; Descriptions</a
749-
>
750-
for each of them. <br />
751-
<br />
752-
When your official configurations have been posted they will appear in the "Custom Configuration"
753-
section:<br />
754-
<br />
755-
<img
756-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_branch_settings.png"
757-
alt="steamworks_steam_input_branch_settings.png"
758-
title="steamworks_steam_input_branch_settings.png"
759-
/><br />
760-
<br />
761-
For each configuration you can get a direct link, see what controller type it is for, control which
762-
beta branches it is available on, or remove it entirely. If you create a new official configuration,
763-
you can use the remove / add functions in this section to replace an existing one.
764-
<h2 class="bb_subsection"><a name="22"></a>Opting Controllers into Steam Input</h2>
720+
<h2 class="bb_subsection"><a name="21"></a>Step 4.3 - Opting Controllers into Steam Input</h2>
765721
<br />
766722
Next, you should set up what kind of controllers use Steam Input - if you are using Steam Input API
767723
you'll want to make sure to check the "Any Future Devices" option to make sure new controllers work
@@ -775,45 +731,20 @@ <h2 class="bb_subsection"><a name="22"></a>Opting Controllers into Steam Input</
775731
<br />
776732
Checking these boxes will cause those controller types to make use of Steam Input rather than their
777733
standard gamepad input protocols.
778-
<h2 class="bb_subsection"><a name="23"></a>Updating your official configurations</h2>
779-
There are two ways to update your configuration. <br />
780-
<ol>
781-
<li>
782-
To make a breaking change such as adding/removing a new action set or adding actions that
783-
must be bound upload a new configuration for each supported controller type and remove the
784-
old configuration. You should also go into the Steam Input Configuration browser with the
785-
account that created the configuration and mark it deleted by hitting:<br />
786-
<br />
787-
<img
788-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_remove_community_config.png"
789-
alt="steamworks_remove_community_config.png"
790-
title="steamworks_remove_community_config.png"
791-
/><br />
792-
</li>
793-
<li>
794-
To make an optional change such as adding a new language for your action name localization
795-
or adding a new optional action that does not need to be bound in every configuration,
796-
upload a single new configuration and use the "Use Action Block" checkbox to make sure the
797-
action block of that configuration is used preferentially on the selected branches.<br />
798-
<br />
799-
<img
800-
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_use_action_block.png"
801-
alt="steamworks_steam_input_use_action_block.png"
802-
title="steamworks_steam_input_use_action_block.png"
803-
/>
804-
</li>
805-
</ol>
806-
<h2 class="bb_section"><a name="24"></a>Tips</h2>
807-
<h2 class="bb_subsection"><a name="25"></a>Dedicated Menu Actions</h2>
734+
<h2 class="bb_subsection"><a name="22"></a>Step 4.4 - Publishing</h2>
735+
Finally you will want to hit "Save" at the bottom of the page and then publish your app changes in
736+
the partner site as usual.
737+
<h2 class="bb_section"><a name="23"></a>Tips</h2>
738+
<h2 class="bb_subsection"><a name="24"></a>Dedicated Menu Actions</h2>
808739
We recommend creating a separate in-game action set for your menu controls, instead of just re-using
809740
actions in your main game set. Most customers won't need to modify this menu controls set, but it's
810741
an easy way to provide the capability to players who actually need it (as can be the case for some
811742
disabled gamers, for example).
812-
<h2 class="bb_subsection"><a name="26"></a>Custom Icons</h2>
743+
<h2 class="bb_subsection"><a name="25"></a>Custom Icons</h2>
813744
The Steam Input system can also create several styles of on-screen menus. Putting your own .png
814745
icons in <strong>&lt;your base game directory&gt;/TouchMenuIcons/*.png</strong> will show them first
815746
in the list for your game's touch/radial menus. This will allow you to set up your own on-screen
816747
radial menus or touch menus with icons bound to specific actions without doing any game/UI code. As
817748
a developer you may wish to do this even if you don’t actually have any radial or touch menus in
818749
your own default configuration. Since any user modified configurations will also have access to
819-
these, users will be able to create nicely themed menus using your official icon art.<br />
750+
these, users will be able to create nicely themed menus using your official icon art.

‎docs/features/steam_controller/workshop_uploaded_configs.html‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
<h1>Uploading Steam Input Configs to Steam Workshop</h1>
2+
<div class="bb_callout">
3+
<div>
4+
For new titles we no longer recommend using the Steam Workshop for managing official game
5+
configurations. Instead recommend to use
6+
<a href="/doc/features/steam_controller/action_manifest_file">Action Manifest Files</a>
7+
bundled with your game depots as they are easier to update for developers and manage
8+
differences within game-branches or when launching the game via the IDE for local
9+
development. This page exists to document the process for game which are already using the
10+
Steam Workshop option for configurations.
11+
</div>
12+
</div>
13+
<br />
14+
Once your game is working with the controller, you're ready to publish. You'll need to release your
15+
new game update and make your configuration the official one. Official configurations are
16+
automatically loaded when a player launches your game for the first time. This allows users to
17+
simply fire up your game and play without needing to go into the configuration screen at all.<br />
18+
<br />
19+
Here's the recommended process:
20+
<h2 class="bb_subsection"><a name="1"></a>Step 1 - Update your game</h2>
21+
<ul>
22+
<li>Update your Steam depot with your new version of the game</li>
23+
</ul>
24+
<h2 class="bb_subsection"><a name="2"></a>Step 2 - Publish your configuration</h2>
25+
<ul>
26+
<li>
27+
Run Steam in Big Picture mode and navigate to the default configuration you created in the
28+
controller configuration.<br />
29+
</li>
30+
<li>Hit the (Y) button, or click the "Save As" button at the bottom of the screen.<br /></li>
31+
<li>
32+
Select the desired localized title &amp; description in the popup, change it to a PUBLIC
33+
profile, and click the PUBLISH button.<br />
34+
</li>
35+
<li>
36+
You will get a confirmation, and the file ID of the public configuration. Copy/save the ID.
37+
</li>
38+
</ul>
39+
<h2 class="bb_subsection"><a name="3"></a>Step 3 - Make the configuration official</h2>
40+
<ul>
41+
<li>Open up your game's page on the Steamworks partner website.<br /></li>
42+
<li>
43+
Select "Steam Input" from the "Application" tab.<br />
44+
<br />
45+
<img
46+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input.png"
47+
alt="steamworks_steam_input.png"
48+
title="steamworks_steam_input.png"
49+
/><br />
50+
<br />
51+
</li>
52+
<li>
53+
Scroll to the section called "Steam Input Template". Select the "Custom Configuration"
54+
option in the dropdown. (If you were not planning on adding native support and just want to
55+
select from common legacy mode presets, here is where you would do so).<br />
56+
<br />
57+
<img
58+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_custom_config.png"
59+
alt="steamworks_steam_input_custom_config.png"
60+
title="steamworks_steam_input_custom_config.png"
61+
/><br />
62+
<br />
63+
And from the selection below, select "Add Custom Configuration."<br />
64+
<br />
65+
<img
66+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_controller_custom2.png"
67+
alt="steamworks_steam_controller_custom2.png"
68+
title="steamworks_steam_controller_custom2.png"
69+
/><br />
70+
<br />
71+
</li>
72+
<li>
73+
Paste the file ID of your public configuration into the box, and click the OK button.<br />
74+
<br />
75+
<img
76+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_controller_custom3.png"
77+
alt="steamworks_steam_controller_custom3.png"
78+
title="steamworks_steam_controller_custom3.png"
79+
/><br />
80+
<br />
81+
</li>
82+
<li>Publish your app changes in the partner site as usual.</li>
83+
</ul>
84+
<br />
85+
If you'd like, you can also specify multiple official configurations for your game. You may want to
86+
create an official "Southpaw" (left-handed) mode, for example.<br />
87+
<br />
88+
To do this, simply create multiple configurations and publish them each via step 2. Then, in step 3,
89+
paste all the file IDs for your configurations into the box, separated by the comma character (,)
90+
characters. The first one on the list will be considered the highest priority, and will be picked by
91+
default for new players. Don't forget to make
92+
<a href="/documentation/steamcontroller#step12" target="_blank" rel="noreferrer"
93+
>Titles &amp; Descriptions</a
94+
>
95+
for each of them. <br />
96+
<br />
97+
When your official configurations have been posted they will appear in the "Custom Configuration"
98+
section:<br />
99+
<br />
100+
<img
101+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_branch_settings.png"
102+
alt="steamworks_steam_input_branch_settings.png"
103+
title="steamworks_steam_input_branch_settings.png"
104+
/><br />
105+
<br />
106+
For each configuration you can get a direct link, see what controller type it is for, control which
107+
beta branches it is available on, or remove it entirely. If you create a new official configuration,
108+
you can use the remove / add functions in this section to replace an existing one.
109+
<h2 class="bb_subsection"><a name="4"></a>Opting Controllers into Steam Input</h2>
110+
<br />
111+
Next, you should set up what kind of controllers use Steam Input - if you are using Steam Input API
112+
you'll want to make sure to check the "Any Future Devices" option to make sure new controllers work
113+
by default without you having to adjust settings after support ships in Steam.<br />
114+
<br />
115+
<img
116+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_optin_settings.png"
117+
alt="steamworks_steam_input_optin_settings.png"
118+
title="steamworks_steam_input_optin_settings.png"
119+
/><br />
120+
<br />
121+
Checking these boxes will cause those controller types to make use of Steam Input rather than their
122+
standard gamepad input protocols.
123+
<h2 class="bb_subsection"><a name="5"></a>Updating your official configurations</h2>
124+
There are two ways to update your configuration. <br />
125+
<ol>
126+
<li>
127+
To make a breaking change such as adding/removing a new action set or adding actions that
128+
must be bound upload a new configuration for each supported controller type and remove the
129+
old configuration. You should also go into the Steam Input Configuration browser with the
130+
account that created the configuration and mark it deleted by hitting:<br />
131+
<br />
132+
<img
133+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_remove_community_config.png"
134+
alt="steamworks_remove_community_config.png"
135+
title="steamworks_remove_community_config.png"
136+
/><br />
137+
</li>
138+
<li>
139+
To make an optional change such as adding a new language for your action name localization
140+
or adding a new optional action that does not need to be bound in every configuration,
141+
upload a single new configuration and use the "Use Action Block" checkbox to make sure the
142+
action block of that configuration is used preferentially on the selected branches.<br />
143+
<br />
144+
<img
145+
src="https://cdn.steamstatic.com/steamcommunity/public/images/steamworks_docs/english/steamworks_steam_input_use_action_block.png"
146+
alt="steamworks_steam_input_use_action_block.png"
147+
title="steamworks_steam_input_use_action_block.png"
148+
/>
149+
</li>
150+
</ol>

‎docs/links.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@
174174
"features/steam_controller/steam_input_gamepad_emulation_bestpractice",
175175
"features/steam_controller/steam_input_gamepad_emulation_bestpractices",
176176
"features/steam_controller/touch_menus",
177+
"features/steam_controller/workshop_uploaded_configs",
177178
"features/steam_input/stats_reports",
178179
"features/steamvr",
179180
"features/steamvr/enterprise",

‎docs/marketing/discounts/dailydeal.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h2 class="bb_section"><a name="2"></a>Daily Deal Eligibility</h2>
4343
<br />
4444
If you think this roughly describes your game, please feel free to
4545
<a
46-
href="https://help.steampowered.com/en/wizard/HelpWithPublishing?issueid=919"
46+
href="https://help.steampowered.com/en/wizard/HelpWithPublishing?issueid=944"
4747
target="_blank"
4848
rel="noreferrer"
4949
>contact us here</a

0 commit comments

Comments
 (0)