[/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.…

Some examples of additional content that could be delivered as DLC include: [list] [*]Expansions [*]New maps or levels [*]Additional characters [/list] DLC could be used for supplemental content that does not show up in-game such as [list] [*]Artbooks or wallpapers [/list] [doclink=store/application/soundtrackapp][/doclink] are handled with a special type of App ID that's different from DLC. …

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 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 [api]steam_api::SteamAPI_RestartAppIfNecessary[/api]. [h4]Q. My game is using D3D12 on Win7, and the Steam overlay is not working. Why?[/h4] [b]A.[/b] Please refer to this [url=https://microsoft.github.io/DirectX-Specs/d3d/D3D12onWin7.html#add-support-to-d3d11on12]Microsoft document[/url] on how to add Steam overlay support. …

[subsection]Common Build Problems[/subsection] [list] [*] [b]Cannot open include file: 'd3d9.h'[/b] If you encounter this error it means that your systems include path does not include the D3D include path, or that you have not installed the D3D SDK. …

If you copy your compiled binary to another machine you may need to install the D3D redistributables to obtain the same version of D3D9X that you compiled against on your development machine. [/list] [section]Code Overview[/section] Once you have the [b]Spacewar!…

[/i] [*][b]OpenXR Action Map[/b] - You can optionally add the Steam Frame Controller profile but things will work via the Oculus Touch interaction profile as well. [*][b]XR Nodes[/b] - Setup XROrigin3D and XRCamera3D nodes in your scene. [*][b]Enable XR[/b] - Enable XR via "use_xr = true" in your viewport [i](see [url=https://docs.godotengine.org/en/stable/tutorials/xr/a_better_xr_start_script.html]this documentation[/url] for a more detailed version)[/i] [code] //Add this to your XROrigin3D node extends XROrigin3D func _ready() -> void: var xr_interface = XRServer.find_interface(“OpenXR”) if xr_interface and xr_interface.is_initialized(): get_viewport().use_xr = true [/code] [*][b]Export Template[/b] - Setup an Export Template if you haven't already (Project / Export) [subsection]Android:[/subsection] [list] [*][b]Add an Android Export Profile[/b] [i](Use the Add… button)[/i] [*][b]Rename the profile[/b] to Steam Frame [*][b]Enable Gradle Build[/b] - Tick the “use gradle build” tickbox [*][b]Set XR mode[/b] - Set the “XR Features/XR mode” to OpenXR [*][b]Enable Khronos plugin[/b] - If you’re using the vendor plugin, tick the "Enable Khronos plugin" tickbox [*][b]Android Build Template[/b] - Install the android build template (Project / Install Android Build Template). …

[/callout] [section]Eye Tracking[/section] Our current support for eye tracking in Unity uses the Eye Gaze Interaction feature. There’s examples of using this in the [url=https://docs.unity3d.com/Packages/com.unity.xr.interaction.toolkit@3.1/manual/index.html]XR Interaction Toolkit samples[/url]. You can learn more about the feature here: [url=https://docs.unity3d.com/Packages/com.unity.xr.openxr@1.0/manual/features/eyegazeinteraction.html]Eye Gaze Interaction | OpenXR Plugin | 1.0.3[/url] [section]Notes[/section] [list] [*][b]Unity Profiler[/b] - Once adb is connected the Unity Profiler should be able to connect as well. [*][b]Android Logcat[/b] - The Android Logcat package found in the Unity Registry section of the Package Manager should work once adb is connected. This gives you nice filtered logs from your game. [url=https://docs.unity3d.com/Packages/com.unity.mobile.android-logcat@0.1/manual/index.html]See the Unity documentation[/url] [*][b]Multiple HMDs[/b] - Disconnect other HMDs, (such as Quest), from your USB while building and debugging. …

[docimg=2019-09-18_16-41-17.png]2019-09-18_16-41-17.png[/docimg] [subsection=sketchfab]Sketchfab[/subsection] It is possible to share awesome 3D models that the development team or that your community have created in a way that is easily explorable by your fan. We use a service called Sketchfab to host the models and to render them into the browser for people to explore. …

[code] https://sketchfab.com/models/<model id> https://sketchfab.com/models/7b08add6fb40478a9bc465a8ef0d8ffb [/code] That would automatically generate a summary block about the 3D model in the event description. This summary includes the items name and authors name. [docimg=2020-03-05_17-48-05.png]2020-03-05_17-48-05.png[/docimg] Then when a user clicks on the summary it will expand into an interactive 3D item explorer. …

[section]Localized Image Management[/section] If you are uploading images that contain text, you can now easily manage localized version of those images all together in an image group. [docimg=b10a3f4768ef3d833c7922d6981fa5f7df4ecbe8.png]b10a3f4768ef3d833c7922d6981fa5f7df4ecbe8.png[/docimg] This gives you one single entry in your list of images and a quick menu option to edit the group. …

Steam Audio offers a wide variety of features, including: [subsection]Overview[/subsection] [list] [*] [b]Render 3D positional audio.[/b] Steam Audio binaurally renders direct sound using HRTFs to accurately model the direction of a sound source relative to the listener. Users can get an impression of the height of the source, as well as whether the source is in front of or behind them. [*] [b]Render 3D audio for Ambisonic content.[/b] Steam Audio can also spatialize Ambisonics audio clips, rotating them based on the listener’s orientation in the virtual world. …

[url=https://steamcommunity.com/games/250820/announcements/detail/1256913672017157095]Read the launch announcement for SteamVR Home here[/url] [subsection]SteamVR Collectibles[/subsection] SteamVR Collectibles are 3D items granted to players based on ownership and playtime of VR games. Developers can create custom items that will drop to players to be used as decoration in SteamVR Home environments. …

The Tag Wizard helps you create a tag profile which includes: [list] [*] [b]Genres[/b], with particular attention to the most specific Genre or Sub-Genre [list] [*] Example: [i]Super Meat Boy[/i] can most specifically be described as a Precision Platformer [*][b]Super-Genre[/b]: Action [*][b]Genre[/b]: Platformer [*][b]Sub-Genre[/b]: Precision Platformer [/list] [*] [b]Visual properties[/b], such as [list] [*] [b]Dimensions[/b]: 2D, 2.5D, 3D [*] [b]Camera Perspective[/b]: Third-Person, First-Person, Top-Down, Isometric, Side-Scroller, etc. [*] [b]Visual Style[/b]: Pixel Graphics, Realistic, Abstract, Anime, Cute, Stylized, Minimalist, etc. …

You can remove any tags you find unwanted ("family friendly" for a horror game) or inaccurate ("2D" for a 3D game). [subsection]Tag page visibility[/subsection] The top 20 tags on your game determine the tag pages and similar browse views that your game can appear on. …

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?…

PowerFormId=1b290fb6-bf33-4529-b6b4-0c05174271f7&env=na1&acct=8eb740d5-3d42-42a7-b032-df44d160f47f&v=2]commercial/government use license[/url]. A PDF copy for your prior review can be downloaded [docfile=2023STEAMVRCOMMERCIALINSTALLATIONLICENSE.pdf]here[/docfile]. …

Simple DirectMedia Layer (SDL) version 2.0 provides low-level access to audio and windowing, amongst many other things. Support for 3D rendering is provided using OpenGL. Installation instructions can be found [url=https://wiki.libsdl.org/Installation]here[/url]. For more information and documentation, see the SDL [url=https://wiki.libsdl.org/FrontPage]wiki[/url]. …

[/th][th]Information[/th][/tr] [tr] [td][url=https://store.steampowered.com/app/220980/]CRYENGINE[/url][/td] [td]✔[/td] [td][/td] [/tr] [tr] [td][url=https://store.steampowered.com/app/585410/]GameMaker Studio 2[/url][/td] [td]✔[/td] [td][url=https://help.yoyogames.com/hc/en-us/articles/216754138-Using-The-Steamworks-SDK-With-GameMaker-Studio]Using The Steamworks SDK With GameMaker: Studio[/url][/td] [/tr] [tr] [td][url=https://godotengine.org/]Godot[/url][/td] [td]❌[/td] [td]Third Party: [url=https://godotsteam.com]GodotSteam[/url] - [url=http://steamcommunity.com/groups/steamworks/discussions/0/1319962244122216920/]Steamworks Developer Discussions support thread[/url][/td] [/tr] [tr] [td][url=https://haxe.org]Haxe[/url][/td] [td]❌[/td] [td]Third Party: [url=https://github.com/larsiusprime/SteamWrap]SteamWrap[/url] - [url=http://steamcommunity.com/groups/steamworks/discussions/0/1327844097134144055/]Steamworks Developer Discussions support thread[/url][/td] [/tr] [tr] [td][url=https://store.steampowered.com/app/251810/]Leadwerks Game Engine[/url][/td] [td]✔[/td] [td][url=https://leadwerks.com/werkspace/page/api-reference/_/steamworks/]Leadwerks API Reference › Steamworks[/url][/td] [/tr] [tr] [td][url=https://store.steampowered.com/app/363890/]RPG Maker MV[/url][/td] [td]❌[/td] [td]Third party: [url=https://github.com/greenheartgames/greenworks]Greenworks[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/666827316032532562/]Steamworks Developer Discussions support thread[/url][/td] [/tr] [tr] [td][url=https://developer.valvesoftware.com/wiki/SDK_Docs]Source 2013[/url][/td] [td]✔[/td] [td][doclink=sdk/uploading/distributing_source_engine][/doclink][/td] [/tr] [tr] [td][url=https://unity3d.com]Unity[/url][/td] [td]❌[/td] [td] Third party: [url=https://github.com/Facepunch/Facepunch.Steamworks]Facepunch.Steamworks[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/1319961618833314524/]Steamworks Developer Discussions support thread[/url] Third party: [url=steamworks.github.io]Steamworks .NET[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/666827974770212954/]Steamworks Developer Discussions support thread[/url] [/td] [/tr] [tr] [td][url=https://unrealengine.com]Unreal Engine 4[/url][/td] [td]✔[/td] [td][url=https://docs.unrealengine.com/4.26/en-US/ProgrammingAndScripting/Online/Steam/]Online Subsystem Steam[/url][/td] [/tr] [tr] [td][url=http://visionaire-studio.net]Visionaire Studio[/url][/td] [td]✔[/td] [td][url=https://wiki.visionaire-tracker.net/wiki/Player_FAQ#Publish_on_Steam]Publish on Steam[/url][/td] [/tr] [/table] [h4]Languages:[/h4] [list] [*] [b]ActionScript (Adobe Flash, AIR)[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732086473/]Discussion thread[/url] [/list] [*] [b]C#[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732095009/]Discussion thread[/url] [*] [url=https://github.com/Facepunch/Facepunch.Steamworks]Facepunch.Steamworks[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/1319961618833314524/]Steamworks Developer Discussions support thread[/url] [*] [url=steamworks.github.io]Steamworks .NET[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/666827974770212954/]Steamworks Developer Discussions support thread[/url] [/list] [*] [b]D[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732139048/]Discussion thread[/url] [*] [url=https://github.com/Extrawurst/DerelictSteamworks]DerelictSteamworks[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732139048/]Steamworks Developer Discussions support thread[/url] [/list] [*] [b]Java[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732145070/]Discussion thread[/url] [*] [url=https://github.com/code-disaster/steamworks4j]steamworks4j[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/618463738391558109/]Steamworks Developer Discussions support thread[/url] [/list] [*] [b]JavaScript[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732147238/]Discussion thread[/url] [*] [url=https://github.com/greenheartgames/greenworks]Greenworks[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/666827316032532562/]Steamworks Developer Discussions support thread[/url] [/list] [*] [b]Python[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1354868867732150829/]Discussion thread[/url] [*] [url=https://github.com/philippj/SteamworksPy]SteamworksPy[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/135514151379602794/]Steamworks Developer Discussions support thread[/url] [/list] [*] [b]Rust[/b] [list] [*] [url=https://steamcommunity.com/groups/steamworks/discussions/0/1744469130478487829/]Discussion Thread[/url] [*] [url=https://github.com/Thinkofname/steamworks-rs]steamworks-rs[/url] - [url=https://steamcommunity.com/groups/steamworks/discussions/0/1744469130477656355/]Steamworks Developer Discussions support thread[/url] [/list] [/list] [section=flat_interface]Flat interface for binding to other languages[/section] The SDK has a few features to facilitate the creation of binding layers for other languages. …

[code] "In Game Actions" { "actions" { "GameControls" { "title" "#Set_GameControls" "StickPadGyro" { "Move" { "title" "#Action_Move" "input_mode" "joystick_move" } "Camera" { "title" "#Action_Camera" "input_mode" "joystick_move" } } "Button" { "attack" "#Action_Attack" "block" "#Action_Block" "jump" "#Action_Jump" "interact" "#Action_Interact" "sneak" "#Action_Sneak" "sidestep" "#Action_Sidestep" "map" "#Action_Map" "menu" "#Action_Menu" } } "MenuControls" { "title" "#Set_MenuControls" "Button" { "MenuUp" "#Menu_Up" "MenuDown" "#Menu_Down" "MenuLeft" "#Menu_Left" "MenuRight" "#Menu_Right" "Affirm" "#Menu_Affirm" "Cancel" "#Menu_Cancel" "Other" "#Menu_Other" "ScrollUp" "#Menu_ScrollUp" "ScrollDown" "#Menu_ScrollDown" "DismissMenu" "#Menu_DismissMenu" } } } "localization" { "english" { "Set_GameControls" "Game Controls" "Set_MenuControls" "Menu Controls" "Action_Move" "Move" "Action_Camera" "Camera" "Action_Attack" "Attack" "Action_Block" "Block" "Action_Jump" "Jump" "Action_Sneak" "Sneak" "Action_Sidestep" "Sidestep" "Action_Interact" "Interact" "Action_Menu" "Menu" "Action_Map" "Map" "Menu_Up" "Up" "Menu_Down" "Down" "Menu_Left" "Left" "Menu_Right" "Right" "Menu_Affirm" "Affirm" "Menu_Cancel" "Cancel" "Menu_Other" "Other" "Menu_ScrollUp" "Scroll Up" "Menu_ScrollDown" "Scroll Down" "Menu_DismissMenu" "Dismiss Menu" } } } [/code] [section=tactics]Turn Based Tactics[/section] This is for a turn-based tactics game where you move units around a grid and issue commands. Also includes actions for controlling a 3D camera and basic navigation. [code] "In Game Actions" { "actions" { "MenuControls" { "title" "#Set_MenuControls" "StickPadGyro" { "MenuCursor" { "title" "#Action_MenuCursor" "input_mode" "absolute_mouse" } } "Button" { "Up" "#Action_Up" "Down" "#Action_Down" "Left" "#Action_Left" "Right" "#Action_Right" "QuickSave" "#Action_QuickSave" "QuickLoad" "#Action_QuickLoad" "Affirm" "#Action_Affirm" "Cancel" "#Action_Cancel" } } "BattleControls" { "title" "#Set_BattleControls" "StickPadGyro" { "BattleCamera" { "title" "#Action_BattleCamera" "input_mode" "absolute_mouse" } "BattleCursor" { "title" "#Action_BattleCursor" "input_mode" "absolute_mouse" } } "Button" { "Up" "#Action_Up" "Down" "#Action_Down" "Left" "#Action_Left" "Right" "#Action_Right" "QuickSave" "#Action_QuickSave" "QuickLoad" "#Action_QuickLoad" "ConfirmCommand" "#Action_ConfirmCommand" "Pause" "#Action_Pause" "Cancel" "#Action_Cancel" "Interact" "#Action_Interact" "EndTurn" "#Action_EndTurn" "Waypoint" "#Action_Waypoint" "NextUnit" "#Action_NextUnit" "PrevUnit" "#Action_PrevUnit" "Ability1" "#Action_Ability1" "Ability2" "#Action_Ability2" "Ability3" "#Action_Ability3" "Ability4" "#Action_Ability4" "Ability5" "#Action_Ability5" "Ability6" "#Action_Ability6" "Ability7" "#Action_Ability7" "Ability8" "#Action_Ability8" "Ability9" "#Action_Ability9" "Ability0" "#Action_Ability0" "CameraRotateLeft" "#Action_CameraRotateLeft" "CameraRotateRight" "#Action_CameraRotateRight" "CameraZoomIn" "#Action_CameraZoomIn" "CameraZoomOut" "#Action_CameraZoomOut" "CameraCenterOnSelection" "#Action_CameraCenterOnSelection" } } } "localization" { "english" { "Set_MenuControls" "Menu Controls" "Action_MenuCursor" "Menu Cursor" "Action_Up" "Up" "Action_Down" "Down" "Action_Left" "Left" "Action_Right" "Right" "Action_QuickSave" "Quick Save" "Action_QuickLoad" "Quick Load" "Action_Affirm" "Affirm" "Action_Cancel" "Cancel" "Set_BattleControls" "Battle Controls" "Action_BattleCamera" "Battle Camera" "Action_BattleCursor" "Battle Cursor" "Action_ConfirmCommand" "Confirm Command" "Action_Pause" "Pause" "Action_Interact" "Interact" "Action_EndTurn" "End Turn" "Action_Waypoint" "Place / Remove Waypoint" "Action_NextUnit" "Next Unit" "Action_PrevUnit" "Previous Unit" "Action_Ability1" "Ability 1" "Action_Ability2" "Ability 2" "Action_Ability3" "Ability 3" "Action_Ability4" "Ability 4" "Action_Ability5" "Ability 5" "Action_Ability6" "Ability 6" "Action_Ability7" "Ability 7" "Action_Ability8" "Ability 8" "Action_Ability9" "Ability 9" "Action_Ability0" "Ability 0" "Action_CameraRotateLeft" "Rotate Camera Left" "Action_CameraRotateRight" "Rotate Camera Right" "Action_CameraZoomIn" "Zoom Camera In" "Action_CameraZoomOut" "Zoom Camera Out" "Action_CameraCenterOnSelection" "Center Camera on Selected Object" } } } [/code] [section=rts] Real Time Strategy[/section] This is for a Real Time Strategy game where you build units & buildings and command units individually or in groups. …

Typically this call is unneeded if your game has a constantly running frame loop that calls the D3D Present API, or OGL SwapBuffers API every frame as is the case in most games. However, if you have a game that only refreshes the screen on an event driven basis then that can break the overlay, as it uses your Present/SwapBuffers calls to drive it's internal frame loop and it may also need to Present() to the screen any time a notification happens or when the overlay is brought up over the game by a user. …