The overlay supports games that use DirectX 7 - 12, OpenGL, Metal, and Vulkan. The overlay will not be active in software-rasterized games. …

[list] [*] [api]ISteamFriends::ActivateGameOverlay[/api] This function can open the game overlay to the dialog specified. [*] [api]ISteamFriends::ActivateGameOverlayToUser[/api] This function can open the game overlay to the dialog specified, with the user passed in as context. [*] [api]ISteamFriends::ActivateGameOverlayToWebPage[/api] This function can open the game overlay to its web browser, and loads the specified url. …

[/list] [/list] [/list] [b]Example Response:[/b] [code=xml] <response> <result>OK</result> <params> <state>WA</state> <country>US</country> <currency>USD</currency> </params> </response> [/code] [section=InitTxn]InitTxn[/section] [code=http]POST https://partner.steam-api.com/ISteamMicroTxn/InitTxn/v3/[/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]Microtransaction[/b] permissions.…

When a "client" user session is indicated via [param]usersession[/param] the user will be required to approve the transaction from within the game overlay on the client. Web sessions will require the user to be logged into Steam via a browser where the transaction will be presented and an approval option displayed. …

However, the [b]Performance Assessment[/b] section of the overlay is only displayed while a VR title is running. After exiting a VR title, the [b]Performance Assessment[/b] section of the overlay remains visible for up to 30 seconds with the current results, even if a VR title is launched immediately. [section]Interpreting the overlay[/section] The [b]Performance Assessment[/b] section of the overlay is shown near the [b]Performance Graph[/b]. [docimg=perf_criteria_overlay.png]A look at the Performance Assessment overlay[/docimg] On the right side of the [b]Performance Graph[/b], the [b]Application Name[/b] and [b]Steam Application ID[/b] are displayed. …

Information about running SteamVR in standalone installations can be found [url=https://partner.steamgames.com/doc/features/steamvr/enterprise]here[/url]. [section]SteamVR Overlay Apps[/section] It is possible to create applications that interact directly with the SteamVR overlay, such as adding additional tabs or enabling other functionality even when other VR applications are running. You can read more about building overlay apps on the OpenVR GitHub page: [url]https://github.com/ValveSoftware/openvr/wiki/IVROverlay_Overview[/url] Overlay apps can be distributed on Steam like other applications by enabling the "Launch SteamVR Overlay" launch option. …

[docimg=steam_controller_back_start.png]steam_controller_back_start.png[/docimg] [subsection=SteamHome]Steam "home" button[/subsection] [b]Reserved[/b] The central Steam "home" button is reserved by the system and can't be used by games & applications. Pressing this button during a game will invoke the Steam overlay. [docimg=steam_controller_home.png]steam_controller_home.png[/docimg] [callout=red,fixed][b]NOTE[/b]: Invoking the Steam overlay will not pause your game! It is up to you to detect the overlay and pause your game yourself.[/callout] You can detect the overlay by calling [api]ISteamUtils::IsOverlayEnabled[/api] [subsection=ShoulderButtons]Shoulder buttons[/subsection] [b]Digital[/b] The shoulder buttons are pretty standard. …

[section]Overview[/section] Screenshot support is provided automatically through the [doclink=features/overlay][/doclink] to every game through Steam and Steamworks provides a set of APIs designed to interact with this system. The Steamworks Screenshots API allows you to take screenshots and add them to a users local screenshot library with additional metadata such as the name of a location in your game or tagging users that appear in the screenshot. [callout][b]NOTE[/b]: The [doclink=features/overlay]Steam Overlay[/doclink] must be active in your game for the Screenshots system to be available.[/callout] Users can press a hotkey controlled by Steam (F12 by default), to trigger a screenshot. …

[b]See Also:[/b] [api]ISteamUtils::GetAPICallResult[/api], [api]ISteamUtils::GetAPICallFailureReason[/api] [subsection=IsOverlayEnabled]IsOverlayEnabled[/subsection] [code=cpp]bool IsOverlayEnabled();[/code] Checks if the [doclink=features/overlay]Steam Overlay[/doclink] is running & the user can access it. The overlay process could take a few seconds to start & hook the game process, so this function will initially return false while the overlay is loading. …

See [apitype]ISteamTimeline::ETimelineGameMode[/apitype] for how to use each value. [subsection=OpenOverlayToGamePhase]OpenOverlayToGamePhase[/subsection] [code=cpp]void OpenOverlayToGamePhase( 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 *pchPhaseID[/td][td]The game phase to show in the overlay.[/td][/tr] [/table] Opens the Steam overlay to the section of the timeline represented by the game phase. [subsection=OpenOverlayToTimelineEvent]OpenOverlayToTimelineEvent[/subsection] [code=cpp]void OpenOverlayToTimelineEvent( const TimelineEventHandle_t );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]ulEvent[/b][/td][td]TimelineEventHandle_t[/td][td]Handle of the event to show in the overlay.…

[h4]Example[/h4] One callback that you will likely wish to use is [api]ISteamFriends::GameOverlayActivated_t[/api]. As the name implies it sends you a callback every time the user activates or deactivates the [doclink=features/overlay][/doclink]. [code=cpp] class CGameManager { private: STEAM_CALLBACK( CGameManager, OnGameOverlayActivated, GameOverlayActivated_t ); }; void CGameManager::OnGameOverlayActivated( GameOverlayActivated_t* pCallback ) { if ( pCallback->m_bActive ) printf( "Steam overlay now active\n" ); else printf( "Steam overlay now inactive\n" ); } [/code] One popular and recommended use case for the [api]ISteamFriends::GameOverlayActivated_t[/api] callback is to pause the game when the overlay opens. …

Steamworks games can use [api]ISteamFriends::ActivateGameOverlayToStore[/api] to display downloadable content in the Steam overlay. [api]ISteamFriends::ActivateGameOverlayToStore[/api] can display all downloadable content for your game (pass in your game's app ID), or information about a specific piece of downloadable content (pass in the app ID of the downloadable content). Before directing a user to the store, Steamworks games should call [api]ISteamUtils::IsOverlayEnabled[/api] to determine if the user has disabled the Steam overlay through the Steam client settings. Note: To prevent version incompatibilities with the executing version of a game and downloadable content, Steam will only download new content if the user is running the newest version of the game. …

[subsection=ActivateGameOverlay]ActivateGameOverlay[/subsection] [code=cpp]void ActivateGameOverlay( const char *pchDialog );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchDialog[/b][/td][td]const char *[/td][td]The dialog to open. …

[subsection=ActivateGameOverlayToUser]ActivateGameOverlayToUser[/subsection] [code=cpp]void ActivateGameOverlayToUser( const char *pchDialog, CSteamID steamID );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchDialog[/b][/td][td]const char *[/td][td]The dialog to open.…

. [*] User will be redirected to the appropriate return URL. [/list] [h4]Steam Overlay / Big Picture web browser:[/h4] [list] [*] Same as Standard Web Browser with no initial sign-in step; user cannot change account [/list] [h4]In-game web browser with Steamworks API authentication cookie:[/h4] [list] [*] If wallet currency does not match, immediate redirect to return url with result code indicating mismatch [*] Web page displays notice to use the Steam Overlay to authorize the purchase [*] Steam Overlay will activate automatically with a purchase/cancel dialog box [*] Overlay closes, flow continues as Standard Web Browser after user selects Purchase or Cancel [/list] [subsection]Example HTML[/subsection] [code] <form action="https://store.steampowered.com/itemcart/checkout" method="post"> <input type="hidden" name="appid" value="234560"> <input type="hidden" name="cart" value="1001,1006*2"> <input type="hidden" name="total" value="USD499"> <input type="hidden" name="sandbox" value="0"> <input type="hidden" name="return" value="http://mystore.com/checkout.php?…

. [*] Upon receiving this request, Steam will automatically activate the Steam overlay and present a dialog to the user listing all of the items, their cost and a button to confirm or authorize the transaction. If the user does not have enough funds in their Steam account, the overlay will guide the user through a funding process. …

This can be accomplished by using the built-in web browser capability of the game overlay. When the game overlay browser is used for authorization, the user will be logged in automatically. To launch the browser use the Steamworks API call [api]ISteamFriends::ActivateGameOverlayToWebPage[/api] Full details on using the game overlay can be found [doclink=features/overlay]here[/doclink]. [*] [b]Step 5[/b] When the user returns to your site, issue an [webapi]ISteamMicroTxn/QueryTxn[/webapi] API call to get the results. …

The following is a non-exhaustive list of features: [list][*]Enables live or pre-recorded content to be streamed to your Steam product page/s[/list] [list][*]Automatically shows the 'Live' tag when applicable throughout the Steam store[/list] [list][*]Steam Chat is integrated into the streaming experience[/list] [list][*]Integrates seamlessly into your existing broadcast plans through multi-streaming (streaming simultaneously to different platforms)[/list] [list][*]Provides a rich broadcast experience complete with audio and graphic overlays (webcam, logos, announcements etc.)[/list] [list][*]Operates on open source technology (OBS)[/list] Here's a screen grab of a broadcast in action on Steam. …

The performer needs to install OBS on her/his desktop, and either stream live game play or stream existing video files. The streaming video with audio and overlays (if any) from the performer's desktop is then either sent directly to Steam client and Web store, or sent to a multi-streaming provider e.g. …

Each Steamworks title can create up to 10,000 leaderboards, and each leaderboard can be retrieved immediately after a player's score has been inserted.[/td][/tr] [tr][td][doclink=features/overlay][/doclink][/td][td]The Steam overlay is a piece of the Steam user interface that can be activated over the top of almost any game launched through Steam. …

[/td][/tr] [tr][td][doclink=features/screenshots][/doclink][/td][td]Screenshot support is provided automatically through the [doclink=features/overlay][/doclink] to every game through Steam and Steamworks provides a set of APIs designed to interact with this system. The Steamworks Screenshots API allows you to take screenshots and add them to a users local screenshot library with additional metadata such as the name of a location in your game or tagging users that appear in the screenshot.…

We strongly recommend visually indicating that the stream is a replay with an overlay on the video. It is fine to indicate where the original content premiered. [*][h4]Q. Can I stream a game not yet released?[/h4] A. …

Can a streamer include their name and/or handle from a different platform?[/h4] A. Yes. [*][h4]Q. Can I overlay my username or handle from another site on Steam broadcast?[/h4] A. Yes. [*][h4]Q. Can I display ads in my feed?[/h4] A. Yes, but it is strongly discouraged since doing so creates a bad user experience. [*][h4]Q. …

Players can open the server browser from the steam client or in the [doclink=features/overlay][/doclink] [docimg=steam_server_browser.png]steam_server_browser.png[/docimg] You can get the same data as the server browser with the API functions available in [api]ISteamMatchmakingServers[/api]. …

[subsection]Add a link from your demo menu screen[/subsection] You can direct customers to the full app from your demo by utilizing the Steam Overlay. The in-app overlay allows you to put a link to the store page right in your app. See the [doclink=features/overlay][/doclink] documentation and [api]ISteamFriends::ActivateGameOverlayToStore[/api] for more details. …

The calls are primarily used to pass information to the Steam Timeline UI [callout][b]NOTE:[/b] The overlay is automatically disabled for 'Software' app types. If you need the overlay enabled, you can do so by: [olist] [*]Making sure your Steam account has the Edit App Metadata permission [*]Navigate from the App's landing page to > Edit Steamworks Settings > Installation tab > General Installation [*]Check box for Enable Steam Overlay for Application [*]Publish [/olist] [/callout] [section=activating]Integrating Steam Timeline functionality in your app[/section] The Steam Timeline API calls can be found here: [api]ISteamTimeline[/api] [section=icons]Timeline Icons[/section] Steam Timelines includes a set of icons ready to use for your game. …

[b]Entitlements[/b] Support for 10.15 (Catalina) requires adding the following entitlements to your build configuration [list][*][code-inline]com.apple.security.cs.disable-library-validation [/code-inline] (allows loading the Steamworks SDK library and overlay library) [*][code-inline]com.apple.security.cs.allow-dyld-environment-variables [/code-inline] (enables the overlay library to be injected into the game process) [/list] [callout=red][b]Note:[/b] Steam is not currently compatible with the [url=https://developer.apple.com/documentation/security/app_sandbox]com.apple.security.app-sandbox[/url] entitlement. …