By default Steam will handle taking screenshots, but you can take over control by hooking the screenshots using [api]ISteamScreenshots::HookScreenshots[/api]. If you're hooking the screenshots you'll be getting a [apitype]ISteamScreenshots::ScreenshotRequested_t[/apitype] callback when the user presses the screenshot hotkey. You can check if you're currently hooking screenshots with [api]ISteamScreenshots::IsScreenshotsHooked[/api]. Regardless of whether you're hooking or not, you will be getting a [apitype]ISteamScreenshots::ScreenshotReady_t[/apitype] callback when the screenshot has been successfully saved to disk. …
This call is asynchronous, a [apitype]ISteamScreenshots::ScreenshotReady_t[/apitype] callback will be sent when the screenshot has finished writing to disk. [subsection=HookScreenshots]HookScreenshots[/subsection] [code=cpp]void HookScreenshots( bool bHook );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]bHook[/b][/td][td]bool[/td][td]Enable ([b]true[/b]) or disable ([b]false[/b]) hooking?…
You can check if hooking is enabled with [api]ISteamScreenshots::IsScreenshotsHooked[/api]. [subsection=IsScreenshotsHooked]IsScreenshotsHooked[/subsection] [code=cpp]bool IsScreenshotsHooked();[/code] Checks if the app is hooking screenshots, or if the Steam Overlay is handling them. …
[/list] [/list] [/list] [b]Example Response:[/b] [code=json] { "response": { "result": "OK", "params": { "count": 4, "orders": [ { "orderid": "1233", "transid": "1234567890123456788", "steamid": "76561197972751825", "status": "PartialRefund", "currency": "USD", "time": "2024-01-23T18:30:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:15:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Refunded" }, { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1234", "transid": "1234567890123456789", "steamid": "76561197972751825", "status": "Failed", "currency": "USD", "time": "2024-01-23T18:40:30Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Failed" } ] }, { "orderid": "1235", "transid": "1234567890123456790", "steamid": "76561197972751825", "status": "Succeeded", "currency": "USD", "time": "2024-01-23T18:40:40Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:30Z", "items": [ { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1236", "transid": "1234567890123456791", "steamid": "76561197972751825", "status": "Chargedback", "currency": "USD", "time": "2024-01-23T19:55:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:40:00Z", "items": [ { "itemid": 102, "qty": 1, "amount": 999, "vat": 89, "itemstatus": "Chargedback" } ] } ] } } } [/code] [section=GetUserAgreementInfo]GetUserAgreementInfo[/section] [code=http]GET https://partner.steam-api.com/ISteamMicroTxn/GetUserAgreementInfo/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 [url=https://partner.steamgames.com/doc/webapi_overview/auth#publisher-keys]publisher key[/url] with [b]Microtransaction[/b] permissions.…
[/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.…
[section=requirements]Requirements[/section] 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 [api]steam_api::SteamAPI_Init[/api]. As such you'll need to make sure to call [api]steam_api::SteamAPI_Init[/api] 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. …
Steam automatically outputs a number of debug to the [code-inline]logs[/code-inline] folder, for others you may need to use [doclink=#command_line_parameters][/doclink] or [doclink=#console_commands][/doclink] to enable them. Using [api]ISteamUtils::SetWarningMessageHook[/api] allows a Steamworks application to register a function that allows the Steamworks API to provide human-readable error messages to the application when something goes wrong. Most Steam APIs use it, so be sure to hook it up and look at it any time something goes wrong. [section=command_line_parameters]Steam Command Line Parameters[/section] Steam uses command line parameters to expose developer details. …
This must be set before calling [api]ISteamClient::CreateLocalUser[/api]! [subsection=SetWarningMessageHook]SetWarningMessageHook[/subsection] [code=cpp]void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pFunction[/b][/td][td]SteamAPIWarningMessageHook_t[/td][td]Function pointer to the callback function.[/td][/tr] [/table] Sets a warning message hook to receive SteamAPI warnings and info messages in a callback function. The function prototype must match the definition in SteamAPIWarningMessageHook_t. …
[b]See Also:[/b] [api]ISteamUtils::IsVRHeadsetStreamingEnabled[/api] [subsection=SetWarningMessageHook]SetWarningMessageHook[/subsection] [code=cpp]void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pFunction[/b][/td][td]SteamAPIWarningMessageHook_t[/td][td]Function pointer to the callback function.[/td][/tr] [/table] Sets a warning message hook to receive SteamAPI warnings and info messages in a callback function. The function prototype must match the definition in SteamAPIWarningMessageHook_t. …
[section]How to Implement[/section] Steam error reporting is easy to use if you're already using [url=https://msdn.microsoft.com/en-us/library/windows/desktop/ms680657(v=vs.85).aspx]Structured Exception Handling[/url]. You must hook up the Win32 [url=https://msdn.microsoft.com/en-us/library/5z4bw5h5.aspx]_set_se_translator[/url] function which calls a function you create to handle the minidump. …
More information on how that is setup can be found here: https://partner.steamgames.com/doc/api/ISteamFriends#richpresencelocalization [*][b]Once you have hooked up the data appropriately, run the game and make sure you are logged into the Steam on the web and then you can test to see if it's working and what will be displayed here: https://steamcommunity.com/dev/testrichpresence[/b] [/list] Below is a code sample to show how simple it is to set this up. …
You can see an example of setting up debug logging inside the [code-inline]RealMain()[/code-inline] function where [api]ISteamClient::SetWarningMessageHook[/api] is called. [*] [b]Crash reporting[/b] -- You may wish to use Steam's built in minidump crash reporting in your games. If you do you'll find an example of installing the exception handler and setting up minidump writing in [code-inline]WinMain()[/code-inline] and [code-inline]MiniDumpFunction()[/code-inline] within [code-inline]Main.cpp[/code-inline]. …
[b]Returns[/b] - N/A [b]What it does[/b] - The constructor initializes a number of members along with grabbing the app ID we are currently running as. In addition it hooks up the call back methods to handle asynchronous calls made to Steam. Finally it makes an initial call to [code-inline]RequestStats()[/code-inline] to get stats and achievements for the current user. …
[/b] Definitely - you can play local co-op on the Steam Deck in a few different ways. You can hook controllers in via Bluetooth, or directly via USB. You can also play with Remote Play Together, where other players are on other Decks or PCs. …
Max size - 128 characters[/td][/tr] [/table] [b]Example response: [/b] [code] "response": { "results": [ { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 123, "bundleid":777 "package_sale_type": "Steam", "platform": "Windows", "country_code": "AU", "base_price": "3995", "sale_price": "1995", "currency": "AUD", "gross_units_sold": 10, "gross_units_returned": -2, "gross_sales_usd": "311.7201", "gross_returns_usd": "-25.5322", "net_tax_usd": "26.0431", "primary_appid": 999, "additional_revenue_share_tier": 0, "net_units_sold": 8, "net_sales_usd": "260.1448", "combined_discount_id": 8888, "total_discount_percentage": 50 }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 456, "package_sale_type": "Steam", "platform": "Windows", "country_code": "CA", "base_price": "5999", "sale_price": "5999", "currency": "CAD", "gross_units_sold": 100, "gross_units_returned": 0, "gross_sales_usd": "4309.0101", "gross_returns_usd": "0.0000", "net_tax_usd": "517.0812", "primary_appid": 1099, "additional_revenue_share_tier": 1, "viw_grant_partnerid": "5200", "net_units_sold": 100, "net_sales_usd": "3791.9288", }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "MicroTxn", "appid": 1099, "game_item_id": 1, "country_code": "US", "currency": "USD", "gross_units_sold": 2, "gross_units_returned": 0, "gross_sales_usd": "9.9800", "gross_returns_usd": "0.0000", "net_tax_usd": "0.9980", "primary_appid": 1099, "additional_revenue_share_tier": 1, "net_units_sold": 2, "net_sales_usd": "8.9820", "avg_sale_price_usd": "4.9900" }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 123, "package_sale_type": "Retail", "platform": "Unknown", "country_code": "AE", "primary_appid": 999, "key_request_id": 7100, "gross_units_activated": 10 }, ], "key_request_info": [ { "key_request_id": 7100, "key_request_notes": "Keys for Key Markets", "game_code_id": 842, "game_code_description": "Retail Distribution - Middle East & North Africa", "territory_code_id": 0, "territory_code_description": "UNUSED" } ], "package_info": [ { "packageid": 123, "package_name": "Grate Expectations: Cheese Preparation Simulator - Deluxe Edition" }, { "packageid": 456, "package_name": "Grate Expectations 2: Curd Your Loins - Launch Edition" } ] "app_info": [ { "appid": 999, "app_name": "Grate Expectations: Cheese Preparation Simulator }, { "appid": 1099, "app_name": "Grate Expectations 2: Curd Your Loins" } ], "bundle_info": [ { "bundleid": 777, "bundle_name": "Grate Expectations Deluxe Bundle" }, ], "combined_discount_info": [ { "combined_discount_id": 8888, "combined_discount_name": "Bundle Discount", "total_discount_percentage": 50, "discount_ids": [11111] }, ], "game_item_info": [ { "appid": 1099, "game_item_id": 1, "game_item_description": "500 Grams of Whey", "game_item_category": "Essential Cheese Product" } ], "country_info": [ { "country_code": "AE", "country_name": "United Arab Emirates", "region": "Middle East & North Africa" }, { "country_code": "AU", "country_name": "Australia", "region": "Oceania" }, { "country_code": "CA", "country_name": "Canada", "region": "North America" }, { "country_code": "US", "country_name": "United States", "region": "North America" }, ], "max_id": "29481179373" [/code] [section=GetAppWishlistReporting]GetAppWishlistReporting[/section] [code=http]GET https://partner.steam-api.com/IPartnerFinancialsService/GetAppWishlistReporting/v001/[/code] [b]Request values[/b][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]Financial[/b] permissions.…
What's Gamepad Emulation? [list] [*] On Windows the Steam Overlay will hook traditional gamepad input APIs such as XInput, DirectInput, RawInput, and Windows.Gaming.Input and inject an emulated Xbox controller device. …
.) [*]If you want to make changes in response to the test results (eg., adding a default controller configuration, hooking up a keyboard API call, etc.), you can publish a new build and request a re-review. [*]If you believe there are errors in the test results, you can respond to the test results directly through the partner site to ask for or present additional information. …
[b]Returns[/b] - N/A [b]What it does[/b] - The constructor initializes a number of members along with grabbing the AppID we are currently running as. In addition it hooks up the call back methods to handle asynchronous calls made to Steam. Finally it makes an initial call to [code-inline]Initialize()[/code-inline] to check that the API is ready. …