[/td][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td]✔[/td][td]SteamID of user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]appID of product[/td][/tr] [tr][td][b]startidx[/b][/td][td]uint32[/td][td]✔[/td][td]Starting index in the result set (0 based)[/td][/tr] [tr][td][b]count[/b][/td][td]uint32[/td][td]✔[/td][td]Number Requested[/td][/tr] [tr][td][b]tagcount[/b][/td][td]uint32[/td][td]✔[/td][td]Number of Tags Specified[/td][/tr] [tr][td][b]usertagcount[/b][/td][td]uint32[/td][td]✔[/td][td]Number of User specific tags requested[/td][/tr] [tr][td][b]hasappadminaccess[/b][/td][td]bool[/td][td][/td][td]Whether the user making the request is an admin for the app and can see private files[/td][/tr] [tr][td][b]fileType[/b][/td][td]uint32[/td][td][/td][td]EPublishedFileInfoMatchingFileType, defaults to k_PFI_MatchingFileType_Items[/td][/tr] [tr][td][b]tag[0][/b][/td][td]string[/td][td][/td][td]Tag to filter result set[/td][/tr] [tr][td][b]usertag[0][/b][/td][td]string[/td][td][/td][td]A user specific tag[/td][/tr] [/table] [b]NOTE:[/b] This call requires a publisher API key to use this method. …

As such this API [b]MUST[/b] be called from a secure server, and can never be used directly by clients! [section=ResultSetSummary]ResultSetSummary[/section] [code=http]POST https://partner.steam-api.com/ISteamPublishedItemSearch/ResultSetSummary/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 publisher authentication key.…

Returns 0 if IP is not mapped IPv4. void SetIPv6LocalHost( uint16 nPort = 0); // Set to the IPv6 localhost address ::1, and the specified port. bool IsLocalHost() const; // Return true if this identity is localhost. …

Listen socket options can be set at the interface layer, /// if you have multiple listen sockets and they all use the same options. /// You can also set connection options on a listen socket, and they set the defaults /// for all connections accepted through this listen socket. …

There doesn't seem to be a limit to how many activators you can add, but any more than five will start to run off of the interface. [section]Activator Settings[/section] Let's break down all the settings available in the activator system. These settings are always available regardless of activation type: [table] [tr][th]Name[/th][th]Values[/th][th]Description[/th][/tr] [tr][td]Activation Type[/td][td]Regular Press, Double Press, Long Press, Start Press, Release Press, Chorded Press, None - Remove Activator[/td][td]Activators determine how the input responds to you. …

[/td][/tr] [tr][td]Repeat Rate[/td][td]0.0-1.0[/td][td]Regular Press, Double Press, Long Press[/td][td]The speed of turbo will be set by this slider.[/td][/tr] [/table]…

Currently in SteamVR we only expose the currently in-use refresh rate. [i]Requirements: OpenXR[/i] [/list] [section]Project Settings[/section] These settings are required for Android OpenXR builds to work on the Steam Frame. [list] [*][b]Enable OpenXR[/b] - Enable the OpenXR Plugin [i](Project settings > XR Management)[/i] [*][b]Disable Meta XR[/b] - Disable all Meta XR and Meta Quest OpenXR Features [i](Project Settings > XR Management > OpenXR > OpenXR Feature Groups)[/i] [i]Note: New versions of the OpenXR Package have fixed having the Meta Quest Support feature enabled while deploying to non-meta headsets, but we recommend turning it off if your application doesn't load into VR correctly.…

[/list] [section]Known Issues[/section] [list] [*][b]GPU Particles[/b] - Due to current TSO settings in FEX, uncached GPU buffer access is extremely slow. Solution: Enable GPU Instancing. Note: This only applies to games running through FEX (e.g. …

Change history: [list] [*] [b]Version 2[/b] - Fixes returning the game name in XML. [/list] [section=SetUserStatsForGame]SetUserStatsForGame[/section] [code=http]POST https://partner.steam-api.com/ISteamUserStats/SetUserStatsForGame/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 publisher authentication key.[/td][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td]✔[/td][td]SteamID of user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]appid of game[/td][/tr] [tr][td][b]count[/b][/td][td]uint32[/td][td]✔[/td][td]Number of stats and achievements to set a value for (name/value param pairs)[/td][/tr] [tr][td][b]name[0][/b][/td][td]string[/td][td]✔[/td][td]Name of stat or achievement to set[/td][/tr] [tr][td][b]value[0][/b][/td][td]uint32[/td][td]✔[/td][td]Value to set[/td][/tr] [/table] Sets a stat for the specified user for the game. …

Once done, follow these steps to upload and deploy the new files: [list] [*]Login to the Steamworks website [*]Select the game you would like to update [*]Select [b]Edit Steamworks Settings[/b] [*]Select [b]SteamPipe[/b] > [b]Web Uploads[/b] [*]Find the depot you need to update [*]Select [b]Choose File[/b] and select the zip file [*]Select [b]Merge With Baseline[/b] from the associated dropdown [*]Select [b]Upload[/b] [*]Once uploaded, you should see a green status message and a new Commit line should appear. [*] Enter a build note, leave the branch setting at [b]"None"[/b] and select [b]Commit[/b]. [*] Select [b]SteamPipe[/b] > [b]Builds[/b] [*] Find your new build and set it live on a private test branch with [b]"Preview Changes"[/b] [*] After testing your game with these new files, set it live on the [b]"Default"[/b] branch [/list] …

[/td][/tr] [tr][td][b]onlytrustedwrites[/b][/td][td]bool[/td][td][/td][td]if this is true the leaderboard scores cannot be set by clients, and can only be set by publisher via SetLeaderboardScore WebAPI. Defaults to false.[/td][/tr] [tr][td][b]onlyfriendsreads[/b][/td][td]bool[/td][td][/td][td]if this is true the leaderboard scores can only be read for friends by clients, scores can always be read by publisher. …

As such this API [b]MUST[/b] be called from a secure server, and can never be used directly by clients! [section=SetLeaderboardScore]SetLeaderboardScore[/section] [code=http]POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/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 publisher authentication key.…

For example, if your game is being distributed on Steam by a publisher, then it's useful for both the publisher and the development studio to be set up with access to the game, even if payments for sales of the game will only go to one of the entities. There are a few ways to grant others access to your applications. …

[b]This method has the following advantages:[/b] [list] [*]You can explicitly set permissions for each individual user account. [*]You can control exactly which individual user accounts have access to your Application. [*]You can control exactly which packages are autogranted to the individual user accounts in the group. …

If a player is visiting your store page and if your product has content descriptors that the user has indicated they do not want to see (including defaults), they will be presented with a warning. This is keyed off the settings you entered in filling out the mature content survey while setting up your store page. These warning pages will let the player know that the content they are about to view is different from the preferences they have previously specified (or the defaults that Steam has). [section]Regional Rating Board Settings[/section] Players may also encounter an age-gate if you enabled age-gates while entering in ratings from regional rating boards such as ESRB or PEGI. …

It is up to the publisher/developer to decide if they want to participate in the program and they are responsible for setting the commercial price. [*][h4]Does the Café Program work for schools and universities?[/h4] Yes. We designed the Café Program to be as flexible as possible. …

[/h4] We will have no limit on the number of PCs that the pool of commercial game licenses can be used across so as long they are all on the same network where the authorized Café Server is located. [*][h4]How do I set up the Steam PC Café Server and enable content cache?[/h4] Instructions on how to set up the server and frequently asked questions around it can be found [url=https://partner.steamgames.com/doc/sitelicense/licensees/gettingstarted/licensemodelpc]here[/url]. [*][h4]How can I add my VAT ID to my license agreement?…

[subsection=PlayPrevious]PlayPrevious[/subsection] [code=cpp]void PlayPrevious();[/code] Have the Steam Music player play the previous song. [subsection=SetVolume]SetVolume[/subsection] [code=cpp]void SetVolume( float flVolume );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]flVolume[/b][/td][td]float[/td][td]The volume percentage to set from [b]0.0[/b] to [b]1.0[/b].[/td][/tr] [/table] Sets the volume of the Steam Music player. [section=callbacks]Callbacks[/section] These are callbacks which can be fired by calling [api]steam_api::SteamAPI_RunCallbacks[/api]. …

[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]The app to use the account for[/td][/tr] [tr][td][b]memo[/b][/td][td]string[/td][td]✔[/td][td]The memo to set on the new account[/td][/tr] [/table] Creates a persistent game server account [section=SetMemo]SetMemo[/section] [code=http]POST https://api.steampowered.com/IGameServersService/SetMemo/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.[/td][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td]✔[/td][td]The SteamID of the game server to set the memo on[/td][/tr] [tr][td][b]memo[/b][/td][td]string[/td][td]✔[/td][td]The memo to set on the new account[/td][/tr] [/table] This method changes the memo associated with the game server account. …

[subsection=SetGamePhaseID]SetGamePhaseID[/subsection] [code=cpp] void SetGamePhaseID( const char *pchPhaseID) ;[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchPhaseID[/b][/td][td]const char *[/td][td]A game-provided persistent ID for a game phase. …

Attributes can be set as many times as the game likes with SetGamePhaseAttribute, and only the last value will be shown to the user. [subsection=SetTimelineGameMode]SetTimelineGameMode[/subsection] [code=cpp]void SetTimelineGameMode( ETimelineGameMode eMode );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]eMode[/b][/td][td][apitype]ISteamTimeline::ETimelineGameMode[/apitype][/td][td]The mode that the game is in.…

[list] [*]Make sure your Steam Deck/Machine is connected to the network, and all updates have been applied ([b]Settings > System[/b]) [*][b]On your Steam Deck/Machine[/b]: Go to Settings > System, and select [b]Enable Developer Mode[/b] under the System Settings section. Then in Settings > Developer, select [b]Pair new host [/b]under the Development Kit section [*][b]On your Dev PC:[/b] In the Devkit tool, look for your Steam Deck/Machine. …

[/td][/tr] [tr=k_cbMaxGameServerGameDir][td][b]k_cbMaxGameServerGameDir[/b][/td][td]int[/td][td]32[/td][td]The maximum size (in UTF-8 bytes, including the null terminator) supported for the game server mod dir which is set with [api]ISteamGameServer::SetModDir[/api].[/td][/tr] [tr=k_cbMaxGameServerMapName][td][b]k_cbMaxGameServerMapName[/b][/td][td]int[/td][td]32[/td][td]The maximum size (in UTF-8 bytes, including the null terminator) supported for game server map names which is set with [api]ISteamGameServer::SetMapName[/api].[/td][/tr] [tr=k_cbMaxGameServerName][td][b]k_cbMaxGameServerName[/b][/td][td]int[/td][td]64[/td][td]The maximum size (in UTF-8 bytes, including the null terminator) supported for game server names which is set with [api]ISteamGameServer::SetServerName[/api].[/td][/tr] [tr=k_cbMaxGameServerTags][td][b]k_cbMaxGameServerTags[/b][/td][td]int[/td][td]128[/td][td]The maximum size (in UTF-8 bytes, including the null terminator) supported for game server tags which is set with [api]ISteamGameServer::SetGameTags[/api].…

[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]AppID of game[/td][/tr] [tr][td][b]starttime[/b][/td][td]uint32[/td][td][/td][td]Start time, set as a Unix timestamp[/td][/tr] [tr][td][b]endtime[/b][/td][td]uint32[/td][td][/td][td]End time, set as a Unix timestamp[/td][/tr] [tr][td][b]continue_token[/b][/td][td]string[/td][td][/td][td]Pagination token from the previous response. …

[/td][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td]*[/td][td]SteamID of the account that will confirm the build change. This parameter is required if betakey is set to public and the app is released[/td][/tr] [tr][td][b]description[/b][/td][td]string[/td][td][/td][td]optional description for this build[/td][/tr] [/table] The steamID is required when an app is released and the betakey is set to public. …

[introblock=LIvestream_2.gif] [h5]In Brief[/h5]Set up a livestream to appear on your game's store page, developer homepage or special sale landing page. [h5]Level of integration[/h5]Basic streaming of your gameplay through Steam is built in. …

[/introblock] [subsection]Table of contents[/subsection] [table] [tr][td]Live Streaming[/td][td]This page[/td][/tr] [tr][td][doclink=store/broadcast/setting_up]Setting Up A Stream[/doclink][/td][td]Requirements, setup, and configuration[/td][/tr] [tr][td][doclink=store/broadcast/demo]Streaming Demos[/doclink][/td][td]Livestreaming a game demo to your store page[/td][/tr] [tr][td][doclink=store/broadcast/stats]Stats & Reporting[/doclink][/td][td]Viewership stats from your past streams[/td][/tr] [tr][td][doclink=store/broadcast/faq]FAQ[/doclink][/td][td]Frequently Asked Questions on Steam broadcast[/td][/tr] [/table] [section]Broadcasting on Steam[/section] Steam offers a feature that allows content to be streamed to Steam client and the web store. …

[section=Functions]Functions[/section] These are global functions which do not require an interface to set up. You can read more about these functions in [doclink=sdk/api#steam_game_servers]Steamworks API Overview - Steam Game Servers[/doclink].…

[/td][/tr] [/table] Initializes the ISteamGameServer interface object, and set server properties which may not be changed. After calling this function, you should set any additional server parameters, and then call [api]ISteamGameServer::LogOnAnonymous[/api] or [api]ISteamGameServer::LogOn[/api]. …

[b]See Also:[/b] [api]ISteamUserStats::ClearAchievement[/api], [api]ISteamUserStats::GetAchievementAndUnlockTime[/api], [api]ISteamUserStats::GetAchievement[/api], [api]ISteamUserStats::SetAchievement[/api] [subsection=SetAchievement]SetAchievement[/subsection] [code=cpp]bool SetAchievement( const char *pchName );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchName[/b][/td][td]const char *[/td][td]The 'API Name' of the Achievement to unlock.…

[/list] [b]See Also:[/b] [api]ISteamUserStats::StoreStats[/api], [api]ISteamUserStats::ResetAllStats[/api], [api]ISteamUserStats::GetAchievementAndUnlockTime[/api], [api]ISteamUserStats::GetAchievement[/api] [subsection=SetStat]SetStat[/subsection] [code=cpp]bool SetStat( const char *pchName, int32 nData ); bool SetStat( const char *pchName, float fData );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchName[/b][/td][td]const char *[/td][td]The 'API Name' of the stat. …

From September 2026 onwards, Steam will require you to create this branch manually first (if it doesn't already exist for your app), and will require it to be password-protected. [section]Setting Up Local Content Server[/section] First choose a simple, but high performance web server that only needs to serve static files. …

Find your local build in the list of current builds and select Local from the dropdown next to the desired local build, then click 'Preview Change'. [docimg=setLCSLive.png]setLCSLive.png[/docimg] [section]Configuring Steam Client To Use Your Local Content Server[/section] For the Steam client to know where to look for your game, you'll need to create a file, [code-inline]steam_dev.cfg[/code-inline] in the same directory that contains steam.exe. …