The billing agreement status will just be for the current renewal status. For example, if the user has paid for 1 month, and then cancels after 1 day, the current status show canceled. In general, you should not use this API to determine if the user has renewed their subscription. …

Empty for non-US countries. [*] [code-inline]country[/code-inline] - ISO 3166-1-alpha-2 country code. [*] [code-inline]currency[/code-inline] - ISO 4217 currency code of prices. [*] [code-inline]status[/code-inline] - Status of the account. …

[subsection]Foveated Rendering[/subsection] SteamVR supports the following recommended OpenXR extensions: [list] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_FB_foveation]XR_FB_foveation[/url] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_FB_foveation_configuration]XR_FB_foveation_configuration[/url] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_FB_foveation_vulkan]XR_FB_foveation_vulkan[/url] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_FB_swapchain_update_state]XR_FB_swapchain_update_state[/url] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_META_foveation_eye_tracked]XR_META_foveation_eye_tracked[/url] [*][url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_META_vulkan_swapchain_create_info]XR_META_vulkan_swapchain_create_info[/url] [/list] [subsection]Eye Tracking[/subsection] Our current support for eye tracking uses the [b]XR_EXT_eye_gaze_interaction [/b]OpenXR extension. You can find details about that on the [url=https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#XR_EXT_eye_gaze_interaction]OpenXR spec site here[/url]. [section]Steamworks SDK[/section] Releases of the [doclink=sdk][/doclink] starting with version 1.63 have included libraries that will let it work on Android ARM64 and Linux ARM64. …

This badge should have a special treatment worthy of the foil cards: silver, platinum, shine, sparkle, etc. Badges are usually displayed on #1B1B1B colored backgrounds. For each badge (Level 1-5 and Foil), please provide the following images: [list] [*]80x80px PNGs with a transparent background (shadow may be included). [*]Unique title for each badge [/list] [docimg=badge1.png]badge1.png[/docimg] [docimg=bg3.png]bg3.png[/docimg] [subsection=emoticons]Emoticons[/subsection] Crafting a badge also grants a single custom emoticon which can be used in chat on Steam, or traded on the Steam Marketplace. …

No other characters are permitted. [/list] [docimg=emoticon1.png]emoticon1.png[/docimg] [subsection=backgrounds]Profile Backgrounds[/subsection] Crafting a badge also grants 1 profile background for that game. …

Example:[code] POST https://api.steampowered.com//ICloudService/CompleteAppUploadBatch/v1/ HTTP/1.1 Host: api.steampowered.com Content-Type: application/x-www-form-urlencoded Content-Length: <body length> access_token=<token>&input_json={ "appid": "1234", "batch_id": "434565457423", "batch_eresult": "1" } [/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]access_token[/b][/td][td]string[/td][td]✔[/td][td]OAuth access token for the user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]Your App ID[/td][/tr] [tr][td][b]batch_id[/b][/td][td]uint64[/td][td]✔[/td][td]The ID number of this batch[/td][/tr] [tr][td][b]batch_eresult[/b][/td][td]uint32[/td][td]✔[/td][td]Result of the batch (see remarks)[/td][/tr] [/table] The [code-inline]batch_eresult[/code-inline] parameter should be either 1 (success) or 2 (failure). …

This request may look like: [code] PUT https://steamcloud-us-west1.storage.googleapis.com/00/00/00/00/1234/012_3_4A77D494_9D267_1464.dat?GoogleAccessId=numbersandletters@developer.gserviceaccount.com&Expires=1595961837&Signature=morestuffhere HTTP/1.1 Host: steamcloud-us-west1.storage.googleapis.com Content-Type: application/octet-stream Content-Length: <body length> Header-from-Steam1: value1 Header-from-Steam2: value2 <file data> [/code] When that completes (whether a success or a failure), call: [subsection]CommitHTTPUpload[/subsection] Example: [code] POST https://api.steampowered.com/ICloudService/CommitHTTPUpload/v1/ HTTP/1.1 Host: api.steampowered.com Content-Type: application/x-www-form-urlencoded Content-Length: <body length> access_token=<token>&input_json={ "appid": "1234", "transfer_succeeded": "1", "filename": "%25WinAppDataLocal%25Foobar%2FGamename%2Fcloud%2Fgames%2Fsave.sav", "file_sha": "FDFE308499263F9361B472648E9F49DC0B8799C8" } [/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]access_token[/b][/td][td]string[/td][td]✔[/td][td]OAuth access token for the user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]Your App ID[/td][/tr] [tr][td][b]transfer_succeeded[/b][/td][td]bool[/td][td]✔[/td][td]true if the PUT request succeeded[/td][/tr] [tr][td][b]filename[/b][/td][td]string[/td][td]✔[/td][td]the file name[/td][/tr] [tr][td][b]file_sha[/b][/td][td]string[/td][td]✔[/td][td]Hex string (40 digits) representing the SHA1 digest of the file.…

[/list] [/list] [b]Example Response:[/b] [code=xml] { "response": { "item_json": "[{ \"accountid\":\"292733980074050545\",\"itemid\":\"1503713096879725\",\"itemdefid\":\"4111\",\"state\":\"removed\" ... } } [/code] [b]Calling Example:[/b] [code] curl --request POST \ --header 'content-type: multipart/form-data' \ --form appid=30400 \ --form 'materialsitemid[0]=1510699974025744' \ --form 'materialsitemid[1]=1510699974025745' \ --form 'materialsitemid[2]=1510699974025746' \ --form 'materialsquantity[0]=1' \ --form 'materialsquantity[1]=1' \ --form 'materialsquantity[2]=5' \ --form steamid=292733980074050545 \ --form outputitemdefid=4111 \ https://api.steampowered.com/IInventoryService/ExchangeItem/v1?…

/IInventoryService/GetInventory/v1?appid=480&steamid=xxxxx&key=yyyyyy' ); curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1 ); $data = curl_exec( $ch ); var_dump($data); [/code] [section=GetItemDefs]GetItemDefs[/section] [code=http]GET https://partner.steam-api.com/IInventoryService/GetItemDefs/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td] [td]Steamworks Web API [url=https://partner.steamgames.com/doc/webapi_overview/auth#publisher-keys]publisher key[/url] with [b]Economy[/b] permissions.…

[/td][td]See [doclink=features/steam_controller/mode_shifting]Mode Shifting[/doclink][/td][/tr] [tr][td][b]Deadzone[/b][/td][td]0.0-1.0[/td][td]If translating from an analog input, the radius of the central region to ignore. 0.0 is nothing, 1.0 is the entire surface.…

It's the next best option to the real thing for providing an emulated 1:1 response. [callout=green][b]NOTE:[/b] Since this mode is seen by the game as a joystick, the sensitivity response is limited by the game's gamepad sensitivity settings. …

[docimg=ds4_controller_share_options.png]ds4_controller_share_options.png[/docimg] [callout=green,fixed][b]NOTE[/b]: SHARE and OPTIONS correspond to SELECT and START on previous PlayStation Controller models.[/callout] [subsection=L1R1]L1 and R1 (Shoulder buttons)[/subsection] [b]Digital[/b] The shoulder buttons are pretty standard. [docimg=ds4_controller_l1_r1.png]ds4_controller_l1_r1.png[/docimg] [subsection=L2R2]L2 and R2 (Shoulder triggers)[/subsection] [b]Analog, 1 axis (each)[/b] Unlike the Steam controller, the L2 and R2 analog triggers on the PlayStation 4 controller do [i]not[/i] have a distinct digital "click" at the end of the normal analog range distinguishing a "full pull" from a "soft pull". …

[url=https://docs.unity3d.com/6000.3/Documentation/Manual/xr-multiview-render-regions.html]Unity documentation[/url] [i]Requirements: Unity 6.1+, Unity OpenXR Plugin 1.14.1+, Vulkan, Multiview[/i] [*][b]Valve Utils: Lepton Validation[/b] - This feature checks through your Unity project and lets you know if there are things setup that will cause the build to fail to run locally on Lepton (Steam Frame's Android translation layer). [i]Requirements: Unity OpenXR Plugin v1.9.1+[/i] [*][b]Valve Utils: Refresh Rate[/b] - This feature lets you query and request refresh rates on the headset via the [url=https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#XR_FB_display_refresh_rate]XR_FB_display_refresh_rate[/url] OpenXR extension. …

[code] "Net32" { "Process 1" "%INSTALLDIR%\\redist\\Controller\\32bitInstaller.exe" "NoCleanUp" "1" "Requirement_OS" { "Is64BitWindows" "0" } } "Net64" { "Process 1" "%INSTALLDIR%\\redist\\Controller\\64bitInstaller.exe" "NoCleanUp" "1" "Requirement_OS" { "Is64BitWindows" "1" } } [/code] [b]OS Type Example[/b] This example will only run on Windows XP [code] "Controller" { "Process 1" "%INSTALLDIR%\\redist\\WinXPInstaller.exe" "NoCleanUp" "1" "Requirement_OS" { "OSType" "Windows XP" } } [/code] [section=environment_variables]Environment Variables[/section] Environment variables are supported in an install script. …

[code] "InstallScript" { "Run Process On Uninstall" { "Process_name" { "Process 1" "process.exe" "Command 1" "/command" } } } [/code] [section=FAQ]Frequently Asked Questions[/section] [b]Q. …

Certain inputs can be mapped to "mouse regions", which send mouse input to the game, but map the input's total range of movement 1:1 with screen space, which means e.g. that touching a specific location on, say, a touch pad, will always put the cursor at the same place on the screen. …

For a rectangular mouse region, it should map 1:1 with the screen's boundaries. For a circular region at this size, it will extend the circle far enough past in both directions to contain the entire size of the screen, with clamping applied at the edges. …

Format is upper-case currency type (USD, EUR, GBP, etc) followed by numeric total. [*] sandbox - is 1 or 0. Note that sandbox=1 will fail whenever sandbox testing is not specifically enabled for your app in Steamworks. [*] return - is a URL that the user will be sent to when checkout is complete and ready to be Finalized. …

[/list] Sample PHP to generate "auth" value: [code=php] define( 'SECRET_ITEMCART_KEY', '11111111111111111111111111111111' ); $appid = '234560'; $cartstring = '1001,1006*2'; $totalstring = 'USD499'; $sandbox = '0'; // or '1' $returnurl = 'http://mystore.com/checkout.php?fromsteam=1&cartid=BA13522FE31&result=[RESULT]&orderid=[ORDERID]&steamid=[STEAMID]&name=[USERNAME]&cc=[CURRENCY]&auth=[AUTH]'; $auth = hash_hmac( "sha1", "$appid\n$cartstring\n$totalstring\n$sandbox\n$returnurl", SECRET_ITEMCART_KEY ); [/code] Sample PHP to validate return URL: [code=php] hash_hmac( "sha1", str_replace( $_GET['AUTH'], "", $_SERVER["REQUEST_URI"] ), SECRET_ITEMCART_KEY ) === $_GET['AUTH'] [/code] The authentication code in the sample HTML form is computed as if the Itemcart secret key is all ones (32 characters long). …

[code] SteamItemInstanceID_t inputItems[2] = { unPaintCanItemDefID, unHatItemDefID }; uint32 inputQuantities[2] = { 1, 1 }; SteamItemDef_t outputItems[1] = { unHatItemDefID }; uint32 outputQuantity[1] = { 1 }; SteamInventoryResult_t resultHandle; SteamInventory()->ExchangeItems( &resultHandle, outputItems, outputQuantity, 1, inputItems, inputQuantities, 2 ); [/code] If you wanted to have a tool that just removed a tag, you can define something like this "Paint Stripper.…

[code] itemdefid: 500 type: tag_generator name: Tag Generator Paint tag_generator_name: paint_color tag_generator_values: red:33;blue:33;green:33;gold:1 itemdefid: 100 type: tag_tool name: Random Paint Can tag_generators: 500 tags_to_remove_on_tool_use: paint_color [/code] Then when a user applies the "Random Paint Can" tool to their "Hat" using the [api]ISteamInventory::ExchangeItems[/api] call, they have a 33% chance to get either "red," "green," or "blue" and a 1% chance to get "gold.…

[section=GetAccountList]GetAccountList[/section] [code=http]GET https://api.steampowered.com/IGameServersService/GetAccountList/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…

[section=ResetLoginToken]ResetLoginToken[/section] [code=http]POST https://api.steampowered.com/IGameServersService/ResetLoginToken/v1/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]key[/b][/td][td]string[/td][td]✔[/td][td]Steamworks Web API user authentication key.…

[docimg=action_set_layers_vehicle_1.png]action_set_layers_vehicle_1.png[/docimg] [code=cpp] void changeVehicle(EVehicleID myVehicle, bool entering) { InputActionSetHandle_t layerHandle; if(myVehicle == AUTOMATIC) { layerHandle = automaticHandle; //automatic transmission -- steer, gas, brake } else if(myVehicle == STICK_SHIFT) { layerHandle = stickShiftHandle; //manual transmission -- steer, gas, brake, clutch, shift gears, etc. } if(entering) { SteamInput()>ActivateActionSetLayer( controllerHandle1, layerHandle ); //apply the vehicle's action set layer when you get in it } else { SteamInput()>DeactivateActionSetLayer( controllerHandle1, layerHandle ); //remove the vehicle's action set layer when you get out of it } } [/code] In this game, players can use their weapon even when riding in a vehicle. …

[docimg=action_set_layers_scope.png]action_set_layers_scope.png[/docimg] [code=cpp] void useScope(bool entering) { if(entering) { SteamInput()->ActivateActionSetLayer( controllerHandle1, scopeHandle ); //apply the scoped-in layer when you scope in } else { SteamInput()->DeactivateActionSetLayer( controllerHandle1, scopeHandle ); //remove the scoped-in layer when you lower the scope } } [/code] Here's how all the layers combine. …

Each recipe consists of an itemdef ID, optionally followed by an "x" separator and a desired (integer) quantity. If quantity is not supplied explicitly, "1" is used as a default. [h4]Bundle format[/h4] [code] bundle_def : item_recipe , { ";" , item_recipe } item_recipe : item_def , [ "x" , quantity ] [/code] [h4]Bundle examples[/h4] [list] [*] Grant one each of itemdef 201, itemdef 202, itemdef 203: [code] type: bundle bundle: 201;202;203[/code] [*] Grant one instance with itemdef 101 and five instances of itemdef 102: [code] type: bundle bundle: 101x1;102x5[/code] [*] Random 90% chance of itemdef 501, 9% chance of itemdef 502, 1% chance of item 503: [code] type: generator bundle: 501x90;502x9;503x1[/code] [*] 90% chance of a common item; 10% chance of a special item. …

[h4]Price Examples[/h4] [list] [*] [code-inline]price_category: 1;VLV100[/code-inline] Preset price category using the Valve-maintained pricing table. [*] [code-inline]price: 1;USD100[/code-inline] ($1.00 in US Dollars) [*] [code-inline]price: 1;USD100,EUR080[/code-inline] ($1.00 in US Dollars or 0.80 in Euro) [*] [code-inline]price: 1;USD100,EUR080;20130607T080000Z-20130606T080000ZUSD50,EUR40[/code-inline] ($1.00 in US Dollars or 0.80 in Euro except from 6/6/2013 on when the price is reduced to $0.50 / 0.40) [*] [code-inline]price: 1;USD100,EUR080;20130609T080000Z-20130606T080000ZUSD50,EUR40[/code-inline] ($1.00 in US Dollars or 0.80 in Euro except from 6/6/2013 until 6/9/13 when the price is reduced to $0.50 / 0.40) [/list] [subsection=SellingBundles]Selling Bundles[/subsection] Bundled items can be listed for sale in the Item Store. …

No configuration work is required for users to access all game functionality.[/td] [/tr] [tr] [td][docimg=playable_50_1.png]Playable badge[/docimg][/td] [td][b]Playable[/b][/td] [td]Your game functions on Frame, but may require manual work from the user. …

([i]Recommendations: We recommend using OpenXR's [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_render_model]XR_EXT_render_model[/url] or [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_interaction_render_model]XR_EXT_interaction_render_model[/url], or OpenVR's [url=https://github.com/ValveSoftware/openvr/blob/0924064316de3effbcd1acf1e309182a2deb1c05/headers/openvr.h#L4782]IVRRenderModel[/url] interface, for obtaining the controller model mesh at runtime in order to automatically support current and future devices.…

Uploading localized assets is a critical step, as it helps customers around the world understand the purchase options you are presenting to them. [docimg=manageeditions3resize_1.png]manageeditions3resize_1.png[/docimg] Once you have managed your editions and uploaded a comparison image, click “Save” to save any changes you have made. …

The Compare Editions asset is much easier for customers to find than having to scroll down and search through the store page for this information. [docimg=manageeditions4resize_1.png]manageeditions4resize_1.png[/docimg] In addition, partners have the ability to display capsule art underneath the purchase option of a given edition on your store page. …

[code] "Action Manifest" { "configurations" { "controller_xboxone" { "0" { "path" "xbox_controller.vdf" } } "controller_steamcontroller_gordon" { "0" { "path" "steam_controller.vdf" } "1" { "path" "steam_controller_motion_controls.vdf" } } } "actions" { } "localization" { } } [/code] Supported controller type strings: [table] [tr][td]Steam Deck Controller[/td][td]controller_neptune[/td][/tr] [tr][td]Steam Controller[/td][td]controller_steamcontroller_gordon[/td][/tr] [tr][td]Xbox 360[/td][td]controller_xbox360[/td][/tr] [tr][td]Xbox One[/td][td]controller_xboxone[/td][/tr] [tr][td]Xbox One Elite Controller[/td][td]controller_xboxelite[/td][/tr] [tr][td]PlayStation 3 Controller[/td][td]controller_ps3[/td][/tr] [tr][td]PlayStation 4 Controller[/td][td]controller_ps4[/td][/tr] [tr][td]DualSense Controller[/td][td]controller_ps5[/td][/tr] [tr][td]DualSense Edge Controller[/td][td]controller_ps5_edge[/td][/tr] [tr][td]Nintendo Switch Pro Controller[/td][td]controller_switch_pro[/td][/tr] [tr][td]Nintendo Switch 2 Pro Controller[/td][td]controller_switch2_pro[/td][/tr] [tr][td]Nintendo Joy-Con (L)[/td][td]controller_switch_joycon_left[/td][/tr] [tr][td]Nintendo Joy-Con (R)[/td][td]controller_switch_joycon_right[/td][/tr] [tr][td]Nintendo Joy-Con Pair[/td][td]controller_switch_joycon_pair[/td][/tr] [tr][td]Remote Play Touch Controller[/td][td]controller_mobile_touch[/td][/tr] [tr][td]Generic Gamepads[/td][td]controller_generic[/td][/tr] [/table] [section]Setting up an Action Manifest File[/section] There are two main ways to setup your action manifest file, either starting from scratch or using an existing IGA file. [subsection]Starting with an In-Game Actions file[/subsection] [subsection]Step 1 - Setting up Dev-mode for Steam Input[/subsection] Before editing the Action Manifest File, we need to enable Steam Input dev-mode so that we can export configurations as a developer and receive error messages if we make mistakes when editing the actions manifest. 1) Go to Steam Big PIcture Mode ->Settings->System and turn on Dev mode for Steam [docimg=export_prestep_1.png]export_prestep_1.png[/docimg] 2) Go to the developer section and turn on "Steam Input Layout Dev Mode" [docimg=export_prestep_2.png]export_prestep_2.png[/docimg] [subsection]Step 2 - Save a configuration[/subsection] If you have an existing IGA file you can save your current configuration out in the controller configuration screen. 1) Select the Gear Icon [docimg=export_step_1.png]export_step_1.png[/docimg] 2) Select "Export layout" [docimg=export_step_2.png]export_step_2.png[/docimg] 3) Select a Title and Description for you game and export the configuration. …

(You can localize the quote in other languages) [b]Some guidelines:[/b] [list][*]Reviews should be accurate and you should have permission to post them [*]Quotes should be relatively short (Ideally 1 or 2 short sentences) [*]Quotes should be localized where possible [docimg=reviewexamples.png]reviewexamples.png[/docimg] [/list] [b]Visibility on Steam[/b] Reviews appear directly below the "Recent Events and Announcements" section and above the "About this game" section. …

You can configure the information using BBCode similar to your game description [docimg=awardinput.png]awardinput.png[/docimg] [b]Some guidelines:[/b] [list][*]Awards should be accurate. [*]Include the most important awards. Usually 1-5 awards is enough. Any more makes it confusing for users. The Awards section is collapsed as a default and can be expanded by the user. [*]Awards should be localized where possible[/list] [b]Visibility on Steam[/b] Awards appear directly below the Share and Embed section on the right hand side of your Steam page [docimg=awardlocation_1.PNG]awardlocation_1.PNG[/docimg] …

It also allows users to play non-VR content on the headset without a separate device. [docimg=steamframe-controllers_1.png]steamframe-controllers_1.png[/docimg] [subsection]VR Compatibility[/subsection] While you will always get a better user experience by tailoring your title to the Frame Controllers specifically, our controller compatibility modes have become quite robust. SteamVR will always use a Frame Controller binding by default but in the case one is not available it will first look for a [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_KHR_generic_controller]OpenXR Generic Controller[/url] binding, then an [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#semantic-paths-oculus-touch-controller-profile]Oculus Touch[/url] binding, and remap those to the Frame Controller layout. …