Steam Overlay (Steamworks Documentation)

Maybe your like

Steamworks Documentation

Documentation Home Page
Getting Started
- Onboarding
- Steam Direct Fee
- Managing Your Steamworks Account
  - User Permission: Receive Steamworks Communication
- Managing Applications
  - Application Management Sharing
  - Transferring Applications
- Bringing Mobile Games to Steam
- Content Survey
  - Age Ratings Mandatory in Germany
- Frequently Asked Questions
Store Presence
- Applications
  - Branches (Betas)
  - Builds
  - Bundles
    - Creating Bundles Across Multiple Developers/Publishers
  - Demos
  - Depots
  - Downloadable Content (DLC)
    - DLC Visibility
  - Game Soundtracks on Steam
  - Packages
    - Autogrant Packages
    - Creating and Configuring Deluxe Packs
  - Platforms
    - Developing for SteamOS and Linux
- Coming Soon
- Developer And Publisher Homepages
  - Homepage Example
- Early Access
- Explain Your Editions
- Franchise Pages
- Free To Play Games
- Graphical Assets - Overview
  - Artwork Overrides
  - Community and Client Icons
  - Event Graphical Assets
  - Graphical Asset Rules
  - Library Assets
  - Store Graphical Assets
- Livestreaming
  - Setting Up A Stream
  - Frequently Asked Questions
  - Broadcast Moderation and Adding Moderators
  - Broadcast Viewership Statistics
  - Livestreaming a Game Demo to the Steam Store
- Localization and Languages
  - Languages Supported on Steam
- Pre-Purchasing on Steam
- Pricing
  - Adding A New Currency
  - Package Pricing CSV Import/Export
  - Recurring Subscriptions
  - Supported Currencies
- Promo Event Tools, Rules, and Guidelines
  - Participating in Third-Party Sales Events
  - Hosting Third-Party Sales Events
- Release Dates
- Release Options
- Release Process
- Removing a product from Steam
- Review Process
- Season Passes
- Steam China
- Steam Tags
- Store Page, Building and Editing
  - Store Page Accolades
  - Store Page Extra Asset Management
  - Store Page Written Description
- Testing On Steam
- Top Sellers Lists
- Trailers
- Updating Your Game - Best Practices
- User Reviews
Features
- Anti-cheat and Game Bans
  - Anti-Cheat Integration
- Common Redistributables
- Enhanced Rich Presence
- Game Notifications
- Microtransactions (In-Game Purchases)
  - Microtransactions Implementation Guide
  - Recurring In-Game Billing
- Multiplayer
  - Game Servers
  - Steam Datagram Relay
  - Steam Matchmaking & Lobbies
    - Matchmaking based on skill
  - Steam Networking
- Stats and Achievements
  - Step by Step: Achievements
  - Step by Step: Stats
- Steam Audio
- Steam Cloud
- Steam Cloud Play (Beta)
- Steam Community
- Steam DRM
- Steam Error Reporting
- Steam Families
- Steam HTML Surface
- Steam Input
  - Action Manifest Files
  - Action Set Layers
  - Activators
  - Browsing Configurations
  - General Concepts
  - Getting Started for Developers
  - Getting Started for Players
  - In-Game Actions File
  - Input Source Modes
  - Input Sources
  - Legacy Mode Bindings
  - Mode Shifting
  - Mouse Regions
  - Radial Menus
  - Steam Input Devices
    - Microsoft Xbox 360 Controller
    - Microsoft Xbox One Controller
    - Sony PlayStation 4 Controller
    - Steam Controller
  - Steam Input Gamepad Emulation - Best Practices
  - Templates for In-Game Actions Files
  - Touch Menus
  - Uploading Steam Input Configs to Steam Workshop
- Steam Inventory Service
  - Steam Inventory Item Accessories
  - Steam Inventory Item Dynamic Properties
  - Steam Inventory Item Store
  - Steam Inventory Item Tags
  - Steam Inventory Item Tools
  - Steam Inventory Schema
  - Steam Inventory Web Functions
- Steam Keys
- Steam Leaderboards
  - Step by Step: Leaderboards
- Steam Overlay
- Steam Playtest
- Steam Remote Play
- Steam Screenshots
- Steam Timelines
- Steam Voice
- Steam Workshop
  - Steam Workshop Implementation Guide
  - Steam Workshop Item Tags
- User Authentication and Ownership
- Virtual Reality
  - SteamVR
  - Application Settings for Virtual Reality
  - SteamVR Input
  - OpenVR
  - SteamVR for Enterprise / Government Use
Finance
- Developer Refund Reporting
- Reporting and Payments
  - Reporting and Payments FAQ
- Taxes FAQ
Sales and Marketing
- Advertising on Steam
- Best Practices, Marketing
- Community Moderation
  - Adding Community Moderators
- Curators and Curator Connect
- Discounting
  - Daily Deals
  - Free Weekends
  - Seasonal Sales
- Events and Announcements Tools
  - Events and Announcements Examples
  - Embeddable Widgets
  - Events and Announcements Review Step
  - Events and Announcements Visibility
  - Events and Announcements Visibility Stats Reporting
  - Event Type: Major Update
  - Event Type: Small Update / Patch Notes
  - Importing HTML
  - Sale Page Tools
    - Sale Page Tools -- Information for Partners
    - Sale Page Tools - Background Groupings
    - Sale Page Tools - Livestreaming (Broadcasting)
    - Sale Page Tools - Minimum Requirements
    - Sale Page Tools - Section Types
      - Sale Page Section: Apps And Bundles
- Features And Tools, Marketing
- Followers
- Google Analytics
- Points Shop Items
- Profile Features
- Steam Branding Guidelines
- Steam Community Items
- Store and Platform Traffic Reporting
- Store Widget
- Upcoming Steam Events
  - Steam Next Fest
    - Steam Next Fest - Tips
    - Steam Next Fest: February 2026
  - Steam Themed Sale Events
    - Steam Animal Fest 2025
    - Steam Board Game Fest 2026
    - Steam Deckbuilders Fest 2026
    - Steam Detective Fest 2026
    - Steam Hidden Object Fest 2026
    - Steam Horse Fest 2026
    - Steam House & Home Fest 2026
    - Steam Medieval Fest 2026
    - Steam Ocean Fest 2026
    - Steam PvP Fest 2026
    - Steam Tower Defense Fest 2026
    - Steam Typing Fest 2026
  - Steam Winter Sale 2025
- UTM Analytics
- Visibility on Steam
  - Update Visibility Rounds
- Wishlists
  - Wishlist Reporting
Steamworks SDK
- Creating and using InstallScripts
- Creating a retail and "Gold Master" disk
- Steamworks API Overview
  - Debugging the Steamworks API
  - Steamworks API Example Application (SpaceWar)
- Updating Game Build
  - Partial Depot Update Instructions
  - Tip - Renaming a live exe
- Uploading to Steam
  - Distributing Open Source Applications on Steam
  - Distributing Source Engine Games / Mods
  - Distributing Your Dedicated Game Server
  - SteamPipe Local Content Server
Web API Overview
- Authentication using Web API Keys
- Error Codes &amp; Responses
- OAuth
Accessibility Features
Steam Deck
- Getting your game ready for Steam Deck
- How to debug Windows games on Steam Deck
- How to load and run games on Steam Deck
- Social Media Templates
- Steam Deck and Proton
- Steam Deck Brand Guidelines and Logos
- Steam Deck Compatibility Review Process
  - Steam Deck Verified Landing Pages
- Steam Deck Developer Kits
- Steam Deck FAQ
- Steam Deck SVG Line Art
- Steamworks Virtual Conference: Steam Deck - Nov 12th 2021
Steam PC Café Program
- Licensees
  - PC Café Requirements and Sign Up Instructions
  - Getting Started
    - Setup instructions for the PC Café model (incl. PC Café Server and Content Cache)
    - Setup instructions for the VR arcade model
  - Frequently Asked Questions
- Publishers
Steamworks API Reference
- ISteamApps Interface
- ISteamClient Interface
- ISteamController Interface (Deprecated)
- ISteamFriends Interface
- ISteamGameCoordinator Interface
- ISteamGameServer Interface
- ISteamGameServerStats Interface
- ISteamHTMLSurface Interface
- ISteamHTTP Interface
- ISteamInput Interface
- ISteamInventory Interface
- ISteamMatchmaking Interface
- ISteamMatchmakingServers Interface
- ISteamMusic Interface
- ISteamNetworking Interface
- ISteamNetworkingMessages Interface
- ISteamNetworkingSockets Interface
- ISteamNetworkingUtils Interface
- ISteamParties Interface
- ISteamRemotePlay Interface
- ISteamRemoteStorage Interface
- ISteamScreenshots Interface
- ISteamTimeline
- ISteamUGC Interface
- ISteamUser Interface
- ISteamUserStats Interface
- ISteamUtils Interface
- ISteamVideo Interface
- SteamEncryptedAppTicket
- steamnetworkingtypes.h
- steam_api.h
- steam_gameserver.h
Steamworks Web API Reference
- IBroadcastService Interface
- ICheatReportingService Interface
- ICloudService Interface
- IEconMarketService Interface
- IEconService Interface
- IGameInventory Interface
- IGameNotificationsService Interface
- IGameServersService Interface
- IInventoryService Interface
- ILobbyMatchmakingService Interface
- IPartnerFinancialsService Interface
- IPlayerService Interface
- IPublishedFileService Interface
- ISiteLicenseService Interface
- ISteamApps Interface
- ISteamCommunity Interface
- ISteamEconomy Interface
- ISteamGameServerStats Interface
- ISteamLeaderboards Interface
- ISteamMicroTxn Interface
- ISteamMicroTxnSandbox Interface
- ISteamNews Interface
- ISteamPublishedItemSearch Interface
- ISteamPublishedItemVoting Interface
- ISteamRemoteStorage Interface
- ISteamUserAuth Interface
- ISteamUser Interface
- ISteamUserStats Interface
- ISteamWebAPIUtil Interface
- IStoreService Interface
- IWorkshopService Interface

Steam Overlay Steamworks Documentation > Features > Steam Overlay

Overview

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. It lets the user access the friends list, web browser, chat, and in-game DLC purchasing.The default key for a user to access the overlay while in a game is SHIFT+TAB, but they can change it in their Steam->Settings dialog.

Requirements

Your game does not need to do anything special for the overlay to work, it automatically hooks into any game launched from Steam! While in development and running your game in a debugger, the overlay is loaded when you call SteamAPI_Init. As such you'll need to make sure to call SteamAPI_Init prior to initializing the OpenGL/D3D device, otherwise it won't be able to hook the device creation.The overlay supports games that use DirectX 7 - 12, OpenGL, Metal, and Vulkan. The overlay will not be active in software-rasterized games.macOS: Overlay support for 10.15 (Catalina) requires adding entitlements to your build configuration. Details are provided on the platforms page.NOTE: The overlay is automatically disabled for 'Software' app types. If you need the overlay enabled, you can do so by:

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

Activating the overlay from your app

There are a set of functions in the Steamworks API that give you direct access to triggering the game overlay.

ISteamFriends::ActivateGameOverlay This function can open the game overlay to the dialog specified.
ISteamFriends::ActivateGameOverlayToUser This function can open the game overlay to the dialog specified, with the user passed in as context.
ISteamFriends::ActivateGameOverlayToWebPage This function can open the game overlay to its web browser, and loads the specified url. It needs to be a full url, e.g. http://www.steamgames.com/.
ISteamFriends::ActivateGameOverlayToStore This function can open the game overlay to the buy DLC for the current game (see Downloadable Content (DLC) for more info)
ISteamUtils::SetOverlayNotificationPosition Sets which corner of the screen you want notifications ('toasts') to appear. Default is the bottom-right corner of the screen.
ISteamUtils::IsOverlayEnabled Returns true if the overlay 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.

Communication from the overlay to your game

The following signals (callbacks) are sent from Steam to your game, based on user action in the overlay:

GameOverlayActivated_t Posted when game overlay activates or deactivates. The game can use this to pause or resume single player games.
GameServerChangeRequested_t Posted when the user selects a friends game to join, contains details about the game server to join.
GameLobbyJoinRequested_t Posted when the user selects a friends game to join, contains details about the lobby to join.

Frequently Asked Questions

NOTE: You may find additional answers on the customer facing support site such as this topic: Steam Community Overlay does not Activate.

Q. Why is the Steam overlay crashing my app?

A. The Steam overlay is used in thousands of games and as such it has been very thoroughly tested and is rarely the cause of a crash. However, because of the way it injects itself into the game, it does often expose memory leaks or memory corruption in the usage of your rendering API that may not have impacted game play.To diagnose overlay crashes with DirectX for example, try to determine how D3D got into a bad state by using the d3d debug runtime with all (info/warning/error/notice) level spew turned on. It might give some hints to orphaned d3d resources. If you don’t find anything that way there may be a more general memory corruption issue. If these always occur on shutdown then it’s likely a shutdown ordering issue with the game not cleaning up as it shuts down.If after debugging the app is still crashing in the overlay, please notify us in the Steamworks Development Group.

Q. Why isn't the Steam overlay showing up in my app?

A. First ensure that you meet the Requirements above. If you do meet the requirements and it's still not showing up, make sure you're launching the app through the Steam client, either directly from the lobby/quick launch list, or by calling SteamAPI_RestartAppIfNecessary.

Q. My game is using D3D12 on Win7, and the Steam overlay is not working. Why?

A. Please refer to this Microsoft document on how to add Steam overlay support.

Q. My game runs in a browser. Can the Overlay work in that?

A. The Steam Overlay requires a game consistently render frames, not pausing rendering or rendering only part of the screen based on dirty rects. Unfortunately, web browsers do not support this model. A workaround for web based games is to host an embedded Chromium inside a native application, with a D3D window and input forwarding to the embedded Chromium. That can be setup to render in offscreen mode, which then renders the resulting chromium texture each frame in the native app. Partners often use CEF to do this, though this is not an easy task.