[Section=Getting Started]Getting Started[/Section] Steam's implementation is based upon [url=http://oauth.net/2/]OAuth 2.0[/url]. During your initial setup you will need to contact Valve with the following information: [list] [*]What permissions you need the user to obtain. …

If you include the state parameter, it will be passed back to the redirect URI after the user has confirmed or denied access. Note that the authorization code grant type is also supported, by using the response_type=code during login. If the user grants access, they will be redirected back to you at [code]http://redirect/uri/here#access_token=token_here&token_type=steam&state=whatever_you_want[/code] The token should be treated as an opaque string. …

[subsection]Configuration List[/subsection] In the controller configuration section the configurations are listed by controller type, then by priority for loading. The "path" value is listed relative to the Action Manifest file's location on-disk. [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. …

[section=GetNewsForApp]GetNewsForApp[/section] [code=http]GET https://api.steampowered.com/ISteamNews/GetNewsForApp/v2/[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]AppID to retrieve news for[/td][/tr] [tr][td][b]maxlength[/b][/td][td]uint32[/td][td][/td][td]Maximum length for the content to return, if this is 0 the full content is returned, if it's less then a blurb is generated to fit.…

They will continue to be usable but it's highly recommended that you use the latest version. Change history: [list] [*] [b]Version 2[/b] - Removes element names from arrays [/list] [section=GetNewsForAppAuthed]GetNewsForAppAuthed[/section] [code=http]GET https://partner.steam-api.com/ISteamNews/GetNewsForAppAuthed/v2/[/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 publisher authentication key.…

param1=value1;param2=value2;param3=value3 etc. Parameter names starting with the character '@' are reserved for internal use and will always return an empty string. …

[subsection=NewLaunchQueryParameters_t]NewLaunchQueryParameters_t[/subsection] Posted after the user executes a steam url with query parameters such as [code-inline]steam://run/<appid>//?param1=value1;param2=value2;param3=value3;[/code-inline] while the game is already running. The new params can be queried with [api]ISteamApps::GetLaunchQueryParam[/api]. …

Please note that you'll need to submit your store presence for review before you can submit your build for review. [docimg=MarkAsReady_2.png]MarkAsReady_2.png[/docimg] [section]Release Yourself When Ready[/section] Once your store page has been approved and it's presence has been set to "coming soon" for a least 2 weeks and the build is reviewed, you will be able to release your game. …

Approved titles will not release themselves -- you need to use these controls yourself at the moment you wish your product to be released. You can check our [doclink=store/types][/doclink] documentation for more information on the types of releases we support. [docimg=ReleaseOptions_2.png]ReleaseOptions_2.png[/docimg] After you click "Release App", you'll see a summary of actions that the release process will do, including publishing the store package, setting a launch discount live if you chose to have one, setting the game to playable and released and applying the release timestamp of "NOW". …

ref=5199-TOKV-4426]Supported Controller Database[/url]. [b]Returns:[/b] [apitype]ISteamController::ESteamInputType[/apitype] [b]Example:[/b] [code=cpp] ESteamInputType inputType = SteamController()->GetInputTypeForHandle(controller1Handle); switch(inputType) { case k_ESteamInputType_Unknown: printf("unknown\n!…

You can use GetControllerForGamepadIndex to get this handle[/td][/tr] [tr][td][b]eDestinationInputType[/b][/td][td][apitype]ESteamInputType[/apitype][/td][td]The controller type you want to translate to. Steam will pick the closest type from your SDK version if k_ESteamInputType_Unknown is used[/td][/tr] [tr][td][b]eSourceOrigin[/b][/td][td]EControllerActionOrigin[/td][td]This is the button you want to translate[/td][/tr] [/table] [b]Returns:[/b] EControllerActionOrigin Get the equivalent origin for a given controller type or the closest controller type that existed in the SDK you built into your game if eDestinationInputType is k_ESteamInputType_Unknown. …

[/td][/tr] [tr=k_EUserReviewsReviewType_Positive][td][b]k_EUserReviewsReviewType_Positive[/b][/td][td]1[/td][td]Only positive reviews.[/td][/tr] [tr=k_EUserReviewsReviewType_Negative][td][b]k_EUserReviewsReviewType_Negative[/b][/td][td]2[/td][td]Only negative reviews.…

[/td][/tr] [tr=k_EUserReviewsPurchaseType_All][td][b]k_EUserReviewsPurchaseType_All[/b][/td][td]1[/td][td]All reviews.[/td][/tr] [tr=k_EUserReviewsPurchaseType_NonSteamPurchase][td][b]k_EUserReviewsPurchaseType_NonSteamPurchase[/b][/td][td]2[/td][td]Only reviews by users who did not purchase the app on Steam.…

[section]Overview[/section] An important part of managing your Steamworks Partner account is deciding who has access to your Applications, and what type of access you'd like to give them. The configuration you choose may differ based on your relationship of individual users and teams involved. …

If the latter, you'll need some help from Valve to get this set up, so please [url=https://help.steampowered.com/en/wizard/Login?redir=%2Fen%2Fwizard%2FHelpWithPublishing%3Fissueid%3D903&title=Sign+in]contact Valve[/url] if this is the case. [*][h4]If my game is published by a different company, how do I create a new Steamworks account without creating a new app and paying the app fee?…

The value field is a comma-delimited list of strings to check. [*] "and" (x1 && x2 && ... && xn) "or" (x1 || x2 || ... || xn) "nand" !(x1 && x2 && ... …

[/td][/tr] [tr=eNoServersListedOnMasterServer][td][b]eNoServersListedOnMasterServer[/b][/td][td]2[/td][td]Only for the internet query type, returned in response callback if no servers of this type match.[/td][/tr] [/table] [section=constants]Constants[/section] These are constants which are defined for use with ISteamMatchmakingServers. …

We start with the "recommended" section selected, where id Software (the developer) has posted their official configuration for DOOM. [docimg=browse_configs_2.png]browse_configs_2.png[/docimg] This is the one we currently have selected, which was selected for us by default when we started the game for the first time. The developer can upload configuration for multiple different controller types -- such as PlayStation 4 controller, Steam Controller, and Xbox 360/One controllers, and on the first run, Steam will detect your device and select the appropriate configuration. …

In the case of bundles, we describe the type and quantity of the contained items. In a generator or playtimegenerator, we describe the types of the possible item to be generated, and the relative weight of each type. …

[code] itemdefid: 600 name: Common generator type: generator bundle: 601;602;603;604;605 itemdefid: 700 name: Special generator type: generator bundle: 701;702;703;704;705 itemdefid: 800 name: Master generator type: generator bundle: 600x9;700x1[/code] [/list] Note that - as in the last example - bundle and generator definitions can be chained. …

For example, if there are 6 main maps for a game you might do a set featuring the 6 maps, or character classes, weapon types, etc. You must set the minimum playtime required to earn a card under the badge's card drop settings. Images Required: [list][*][b]Type:[/b] Large Card Images [b]Format:[/b] 1920px x 1080px JPG, smaller than 350KB. [b]Description:[/b] These act as "zoomed in" versions of the smaller card image. They must be thematically similar to the small image. [*][b]Type:[/b] Small Card Images [b]Format:[/b] 206px x 184px PNG [b]Description:[/b] These act as a view into the large image and will have the card title and frame overlaid onto it automatically. [*][b]Type:[/b] Game Logo [b]Format:[/b] 206px x 44px transparent PNG, must be legible on both dark and light backgrounds. …

[/td][/tr] [tr=k_ESteamAPICallFailureInvalidHandle][td][b]k_ESteamAPICallFailureInvalidHandle[/b][/td][td]2[/td][td]The [apitype]steam_api::SteamAPICall_t[/apitype] handle passed in no longer exists.[/td][/tr] [tr=k_ESteamAPICallFailureMismatchedCallback][td][b]k_ESteamAPICallFailureMismatchedCallback[/b][/td][td]3[/td][td][apitype]ISteamUtils::GetAPICallResult[/apitype] was called with the wrong callback type for this API call.…

[/td][/tr] [tr=k_ESteamHardwareTypeSteamDeck][td][b]k_ESteamHardwareTypeSteamDeck[/b][/td][td]1[/td][td]Running on a Steam Deck.[/td][/tr] [tr=k_ESteamHardwareTypeSteamMachine][td][b]k_ESteamHardwareTypeSteamMachine[/b][/td][td]2[/td][td]Running on a Steam Machine.…

[/td][/tr] [tr][td][b]appdata[/b][/td][td]uint64[/td][td][/td][td](Optional) App specific data about the type of cheating set by developer. (ex 1 = Aimbot, 2 = Wallhack, 3 = Griefing)[/td][/tr] [tr][td][b]heuristic[/b][/td][td]bool[/td][td][/td][td](Optional) Extra information about the source of the cheating - was it a heuristic.…

[b]Response:[/b] [ { "name": "success", "type": "bool", "description": "" } ] …

[b]Example:[/b] [code=cpp]void CInventory::GrantPromoItems() { SteamItemDef_t newItems[2]; newItems[0] = 110; newItems[1] = 111; SteamInventory()->AddPromoItems( &s_GenerateRequestResult, newItems, 2 ); }[/code] [subsection=CheckResultSteamID]CheckResultSteamID[/subsection] [code=cpp]bool CheckResultSteamID( SteamInventoryResult_t resultHandle, CSteamID steamIDExpected );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]resultHandle[/b][/td][td][apitype]ISteamInventory::SteamInventoryResult_t[/apitype][/td][td]The inventory result handle to check the Steam ID on.…

[b]Example:[/b] [code=cpp]void CInventory::GrantTestItems() { SteamItemDef_t newItems[2]; uint32 quantities[2]; newItems[0] = 110; newItems[1] = 111; quantities[0] = 1; quantities[1] = 1; SteamInventory()->GenerateItems( &s_GenerateRequestResult, newItems, quantities, 2 ); }[/code] [subsection=GetAllItems]GetAllItems[/subsection] [code=cpp]bool GetAllItems( SteamInventoryResult_t *pResultHandle );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pResultHandle[/b][/td][td][apitype]ISteamInventory::SteamInventoryResult_t[/apitype] *[/td][td]Returns a new inventory result handle.…

[subsection=RetrieveMessage]RetrieveMessage[/subsection] [code=cpp]EGCResults RetrieveMessage( uint32 *punMsgType, void *pubDest, uint32 cubDest, uint32 *pcubMsgSize );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]punMsgType[/b][/td][td][apitype]steam_api::uint32[/apitype] *[/td][td][/td][/tr] [tr][td][b]pubDest[/b][/td][td]void *[/td][td][/td][/tr] [tr][td][b]cubDest[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td][/td][/tr] [tr][td][b]pcubMsgSize[/b][/td][td][apitype]steam_api::uint32[/apitype] *[/td][td][/td][/tr] [/table] Fills the provided buffer with the first message in the queue and returns k_EGCResultOK or returns k_EGCResultNoMessage if there is no message waiting. pcubMsgSize is filled with the message size. …

[b]Returns:[/b] [apitype]ISteamGameCoordinator::EGCResults[/apitype] [subsection=SendMessage]SendMessage[/subsection] [code=cpp]EGCResults SendMessage( uint32 unMsgType, const void *pubData, uint32 cubData );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unMsgType[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td][/td][/tr] [tr][td][b]pubData[/b][/td][td]const void *[/td][td][/td][/tr] [tr][td][b]cubData[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td][/td][/tr] [/table] Sends a message to the Game Coordinator. …

[/td][/tr] [tr][td][b]pchFilename[/b][/td][td]const char *[/td][td]The absolute file path to a 2D JPG, PNG, or TGA version of the screenshot for the library view.[/td][/tr] [tr][td][b]pchVRFilename[/b][/td][td]const char *[/td][td]The absolute file path to the VR screenshot, this should be the same type of screenshot specified in [code-inline]eType[/code-inline].…

[b]Associated Functions:[/b] [api]ISteamScreenshots::TriggerScreenshot[/api] [section=enums]Enums[/section] These are enums which are defined for use with ISteamScreenshots. [subsection=EVRScreenshotType]EVRScreenshotType[/subsection] Describes the type of VR screenshots. [table] [tr][th]Name[/th][th]Value[/th][th]Description[/th][/tr] [tr=k_EVRScreenshotType_None][td][b]k_EVRScreenshotType_None[/b][/td][td]0[/td][td][/td][/tr] [tr=k_EVRScreenshotType_Mono][td][b]k_EVRScreenshotType_Mono[/b][/td][td]1[/td][td][/td][/tr] [tr=k_EVRScreenshotType_Stereo][td][b]k_EVRScreenshotType_Stereo[/b][/td][td]2[/td][td][/td][/tr] [tr=k_EVRScreenshotType_MonoCubemap][td][b]k_EVRScreenshotType_MonoCubemap[/b][/td][td]3[/td][td][/td][/tr] [tr=k_EVRScreenshotType_MonoPanorama][td][b]k_EVRScreenshotType_MonoPanorama[/b][/td][td]4[/td][td][/td][/tr] [tr=k_EVRScreenshotType_StereoPanorama][td][b]k_EVRScreenshotType_StereoPanorama[/b][/td][td]5[/td][td][/td][/tr] [/table] [section=typedefs]Typedefs[/section] These are typedefs which are defined for use with ISteamScreenshots. …

[subsection=SetConfigValue]SetConfigValue[/subsection] [code=cpp]bool SetConfigValue( ESteamNetworkingConfigValue eValue, ESteamNetworkingConfigScope eScopeType, intptr_t scopeObj, ESteamNetworkingConfigDataType eDataType, const void *pArg );[/code] Set a configuration value. [list] [*] eValue: which value is being set [*] eScope: Onto what type of object are you applying the setting? …

E.g. connection handle, listen socket handle, interface pointer, etc. [*] eDataType: What type of data is in the buffer at pValue? This must match the type of the variable exactly! [*] pArg: Value to set it to. …

[subsection]Header File[/subsection] We first define a structure to hold our stats data received from steam, define stat types in a handy enum and then provide a macro for creating stats objects. This data maps directly to what is found on the [url=https://partner.steamgames.com/apps/stats/]Stats Configuration[/url] page. [code=cpp] #define _STAT_ID( id,type,name ) { id, type, name, 0, 0, 0, 0 } enum EStatTypes { STAT_INT = 0, STAT_FLOAT = 1, STAT_AVGRATE = 2, }; struct Stat_t { int m_ID; EStatTypes m_eStatType; const char *m_pchStatName; int m_iValue; float m_flValue; float m_flAvgNumerator; float m_flAvgDenominator; }; [/code] Next we define a helper class that will wrap all of the Steam Stats API calls as well as creating all of the [doclink=sdk/api#callbacks]Steam callbacks[/doclink]. …

[/td][/tr] [tr][td][b]pszPreviewFile[/b][/td][td]const char *[/td][td]Absolute path to the local image.[/td][/tr] [tr][td][b]type[/b][/td][td][apitype]ISteamUGC::EItemPreviewType[/apitype][/td][td]The type of this preview.[/td][/tr] [/table] Adds an additional preview file for the item. …

[/td][/tr] [tr][td][b]eFileType[/b][/td][td][apitype]ISteamRemoteStorage::EWorkshopFileType[/apitype][/td][td]The type of UGC to create.[/td][/tr] [/table] Creates a new workshop item with no content attached yet. …