[b]Performance[/b] [list] [*][b]2D titles[/b]: your game must run at a minimum 30 fps at 1280x720 during normal play. [*][b]VR titles[/b]: your game must run at a minimum of 72 fps at 1728x1728 during normal play. ([i]Recommendations: We strongly recommend submitting both motion vector and depth suitable for reprojection. This will not automatically throttle your application, but will enable users to optionally run at higher refresh rates using improved reprojection techniques.[/i]) VR games below 1440x1440 will appear with an [docimg=unsupported_18.png]Unsupported badge[/docimg] [b]Unsupported[/b] badge. [callout]To assist in evaluating performance, we've added a [doclink=steamframe/compat/perf_criteria]Performance Assessment Overlay[/doclink] to SteamVR. …

Steam Machine has a discrete semi-custom AMD desktop class CPU and GPU, and is roughly 6 times more powerful than Steam Deck. Steam Machine dev-kit units are not currently available. The best way to ensure compatibility on Steam Machine is to work on your title's compatibility with Steam Deck. …

However the request may have failed - the detailed Steam error code will be found in the [code-inline]x-eresult[/code-inline] header. The value for "success" is 1. All other values are likely to be errors; see the documentation for [doclink=api/steam_api]steam_api.h[/doclink] for details. …

[subsection]Delete[/subsection] Example: [code] POST https://api.steampowered.com/ICloudService/Delete/v1/ HTTP/1.1 Host: api.steampowered.com Content-Type: application/x-www-form-urlencoded Content-Length: <body length> access_token=<token>&input_json={ "appid": "1234", "filename": "%25WinAppDataLocal%25Foobar%2FGamename%2Fcloud%2Fgames%2Fsave.sav" } [/code] [table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr][td][b]access_token[/b][/td][td]string[/td][td]✔[/td][td]OAuth access token for the user[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]Your App ID[/td][/tr] [tr][td][b]filename[/b][/td][td]string[/td][td]✔[/td][td]filename of the file to delete[/td][/tr] [/table] This API will delete the specified file from the user's Steam Cloud. …

[/list] [subsection]Integrations[/subsection] Steam Audio includes the following integrations with game engines and audio middleware: [list] [*] Unity 2017.3 or later [url=https://valvesoftware.github.io/steam-audio/doc/unity/index.html](documentation)[/url] [*] Unreal Engine 4.27 or later [url=https://valvesoftware.github.io/steam-audio/doc/unreal/index.html](documentation)[/url] [*] FMOD Studio 2.00 or later [url=https://valvesoftware.github.io/steam-audio/doc/fmod/getting-started.html](documentation)[/url] [*] C/C++ SDK to allow integrating Steam Audio with any other game engine or audio middleware [url=https://valvesoftware.github.io/steam-audio/doc/capi/index.html](documentation)[/url] [/list] [subsection]Supported Platforms[/subsection] Steam Audio supports the following platforms: [list] [*] Windows 7 or later (32-bit and 64-bit) [*] Linux (32-bit and 64-bit, tested with Ubuntu 18.04 LTS) [*] macOS 10.7 or later (64-bit Intel) [*] Android 5.0 or later (32-bit ARM, 64-bit ARM, 32-bit Intel, and 64-bit Intel) [*] iOS 11.0 or later (64-bit ARM) [/list] The C/C++ SDK and various plugins are built using the cross-platform [url=https://cmake.org/]CMake build system[/url], allowing it to be ported to other platforms as needed. …

[section]HTML Supported[/section] This is the list of support HTML that we convert to their equivalent bbcode [list] [*]<a href="[i]url[/i]">[i]text[/i]</a> turns into URLs [*]<img src="[i]url[/i]"> turns into an image [*]<b></b>, <strong></strong> turns into bold [*]<i></i>, <em></em> turns into italics [*]<u></u>, <span></span> turns into underline [*]<p>, <br> turns into new lines [*]<h1> ... <h6> turns into headline [*]<ul>, <ol> turns into an unordered list [*]<li> turns into list items [*]<table> turns into table start [*]<th> turns into table header row [*]<tr> turns into table row [*]<td> turns into table column [/list] [subsection]HTML Ignored[/subsection] <html>, <head>, <doctype>, <thead>, <tbody>, <title>, <div>, <hr> and any tag not in the previous list. …

[docimg=xboxone_controller.png]xboxone_controller.png[/docimg] The physical inputs are identical to the [doclink=features/steam_controller/device/x360_controller]Xbox 360 Controller[/doclink], with a few small cosmetic differences: [*] The face buttons have a darker color scheme [*] The Dpad has a more traditional form factor [*] The Xbox guide (aka "home") button has a new design [*] The BACK and START buttons are now called VIEW and MENU and have new labels (two overlapping windows and a 3-line "hamburger menu"). …

Find all kinds of Steam-related videos on our Steamworks Development YouTube channel https://www.youtube.com/user/steamworksdev [section]Steamworks Socials[/section] For the latest on new features, tips, and updates. On X (Twitter): https://twitter.com/steamworks On Bluesky: https://bsky.app/profile/partner.steamgames.com…

Default set of icons: [no_glow] [table] [tr] [th]Icon[/th][th]Name[/th][th]Description[/th] [/tr] [tr] [td][docimg=marker_2.png][/docimg][/td][td]steam_marker[/td][td]Marker[/td] [/tr] [tr] [td][docimg=achievment_1.png][/docimg][/td][td]steam_achievement[/td][td]Achievement[/td] [/tr] [tr] [td][docimg=attack_1.png][/docimg][/td][td]steam_attack[/td][td]Attack[/td] [/tr] [tr] [td][docimg=bolt_1.png][/docimg][/td][td]steam_bolt[/td][td]Bolt[/td] [/tr] [tr] [td][docimg=bookmark_1.png][/docimg][/td][td]steam_bookmark[/td][td]Bookmark[/td] [/tr] [tr] [td][docimg=bug.png][/docimg][/td][td]steam_bug[/td][td]Bug[/td] [/tr] [tr] [td][docimg=cart.png][/docimg][/td][td]steam_cart[/td][td]Cart[/td] [/tr] [tr] [td][docimg=caution.png][/docimg][/td][td]steam_caution[/td][td]Caution[/td] [/tr] [tr] [td][docimg=chat.png][/docimg][/td][td]steam_chat[/td][td]Chat[/td] [/tr] [tr] [td][docimg=checkmark.png][/docimg][/td][td]steam_checkmark[/td][td]Checkmark[/td] [/tr] [tr] [td][docimg=chest.png][/docimg][/td][td]steam_chest[/td][td]Chest[/td] [/tr] [tr] [td][docimg=circle.png][/docimg][/td][td]steam_circle[/td][td]Circle[/td] [/tr] [tr] [td][docimg=combat.png][/docimg][/td][td]steam_combat[/td][td]Combat[/td] [/tr] [tr] [td][docimg=completed.png][/docimg][/td][td]steam_completed[/td][td]Completed[/td] [/tr] [tr] [td][docimg=crown.png][/docimg][/td][td]steam_crown[/td][td]Crown[/td] [/tr] [tr] [td][docimg=death.png][/docimg][/td][td]steam_death[/td][td]Death[/td] [/tr] [tr] [td][docimg=defend.png][/docimg][/td][td]steam_defend[/td][td]Defend[/td] [/tr] [tr] [td][docimg=diamond.png][/docimg][/td][td]steam_diamond[/td][td]Diamond[/td] [/tr] [tr] [td][docimg=edit.png][/docimg][/td][td]steam_edit[/td][td]Edit[/td] [/tr] [tr] [td][docimg=effect.png][/docimg][/td][td]steam_effect[/td][td]Effect[/td] [/tr] [tr] [td][docimg=explosion.png][/docimg][/td][td]steam_explosion[/td][td]Explosion[/td] [/tr] [tr] [td][docimg=fix.png][/docimg][/td][td]steam_fix[/td][td]Fix[/td] [/tr] [tr] [td][docimg=flag.png][/docimg][/td][td]steam_flag[/td][td]Flag[/td] [/tr] [tr] [td][docimg=gem.png][/docimg][/td][td]steam_gem[/td][td]Gem[/td] [/tr] [tr] [td][docimg=group.png][/docimg][/td][td]steam_group[/td][td]Group[/td] [/tr] [tr] [td][docimg=heart.png][/docimg][/td][td]steam_heart[/td][td]Heart[/td] [/tr] [tr] [td][docimg=info.png][/docimg][/td][td]steam_info[/td][td]Info[/td] [/tr] [tr] [td][docimg=invalid.png][/docimg][/td][td]steam_invalid[/td][td]Invalid[/td] [/tr] [tr] [td][docimg=minus.png][/docimg][/td][td]steam_minus[/td][td]Minus[/td] [/tr] [tr] [td][docimg=pair.png][/docimg][/td][td]steam_pair[/td][td]Pair[/td] [/tr] [tr] [td][docimg=person.png][/docimg][/td][td]steam_person[/td][td]Person[/td] [/tr] [tr] [td][docimg=plus.png][/docimg][/td][td]steam_plus[/td][td]Plus[/td] [/tr] [tr] [td][docimg=purchase.png][/docimg][/td][td]steam_purchase[/td][td]Purchase[/td] [/tr] [tr] [td][docimg=question.png][/docimg][/td][td]steam_question[/td][td]Question[/td] [/tr] [tr] [td][docimg=ribbon.png][/docimg][/td][td]steam_ribbon[/td][td]Ribbon[/td] [/tr] [tr] [td][docimg=screenshot.png][/docimg][/td][td]steam_screenshot[/td][td]Screenshot[/td] [/tr] [tr] [td][docimg=scroll.png][/docimg][/td][td]steam_scroll[/td][td]Scroll[/td] [/tr] [tr] [td][docimg=square.png][/docimg][/td][td]steam_square[/td][td]Square[/td] [/tr] [tr] [td][docimg=star.png][/docimg][/td][td]steam_star[/td][td]Star[/td] [/tr] [tr] [td][docimg=starburst.png][/docimg][/td][td]steam_starburst[/td][td]Starburst[/td] [/tr] [tr] [td][docimg=timer.png][/docimg][/td][td]steam_timer[/td][td]Timer[/td] [/tr] [tr] [td][docimg=transfer.png][/docimg][/td][td]steam_transfer[/td][td]Transfer[/td] [/tr] [tr] [td][docimg=triangle.png][/docimg][/td][td]steam_triangle[/td][td]Triangle[/td] [/tr] [tr] [td][docimg=trophy.png][/docimg][/td][td]steam_trophy[/td][td]Trophy[/td] [/tr] [tr] [td][docimg=view.png][/docimg][/td][td]steam_view[/td][td]View[/td] [/tr] [tr] [td][docimg=x.png][/docimg][/td][td]steam_x[/td][td]X[/td] [/tr] [/table] [/no_glow] [section=example]Example Code[/section] Below is a code sample for integrating Steam Timeline with Left 4 Dead. …

[table] [tr] [td]OpenVR (Depth-assisted reprojection)[/td] [td][url=https://github.com/ValveSoftware/openvr/wiki/IVRCompositor::Submit]IVRCompositor::Submit[/url] with [url=https://github.com/ValveSoftware/openvr/blob/v2.15.6/headers/openvr.h#L191]VRTextureWithPoseAndDepth_t[/url][/td] [/tr] [tr] [td]OpenVR (Depth+Motion-assisted reprojection)[/td] [td][url=https://github.com/ValveSoftware/openvr/wiki/IVRCompositor::Submit]IVRCompositor::Submit[/url] with [url=https://github.com/ValveSoftware/openvr/blob/v2.15.6/headers/openvr.h#L202]VRTextureWithMotion_t[/url][/td] [/tr] [tr] [td]OpenXR (Depth-assisted reprojection)[/td] [td][url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XR_KHR_composition_layer_depth.html]XR_KHR_composition_layer_depth[/url][/td] [/tr] [tr] [td]OpenXR (Depth+Motion-assisted reprojection) Vendor-agnostic[/td] [td][url=https://registry.khronos.org/OpenXR/specs/1.1/man/html/XR_EXT_frame_synthesis.html]XR_EXT_frame_synthesis[/url][/td] [/tr] [tr] [td]OpenXR (Depth+Motion-assisted reprojection) Oculus[/td] [td][url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XR_FB_space_warp.html]XR_FB_space_warp[/url][/td] [/tr] [/table] You can visualize the depth or motion vectors submitted by using the [doclink=steamframe/debugging#GameTextures]Draw Performance Assessment Game Textures in Headset[/doclink] option. …

[list] [*] [doclink=features/steam_controller/device/steam_controller]Steam Controller[/doclink] [*] [doclink=features/steam_controller/device/ps4_controller]Playstation 4 Controller[/doclink] [*] [doclink=features/steam_controller/device/x360_controller]Xbox 360 Controller[/doclink] [*] [doclink=features/steam_controller/device/xb1_controller]Xbox One Controller[/doclink] [*] [doclink=features/steam_controller/device/nsp_controller]Nintendo Switch Pro Controller[/doclink] [*] Steam Link App Mobile Touch Controller [*] Playstation 3 Controller [*] Any DirectInput gamepad [/list] [docimg=controllers.jpg]controllers.jpg[/docimg] Note that the terms "Playstation 4 controller", "Xbox 360 controller", and "Xbox One controller" also refer to any variant devices (such as fighting game joysticks) that use the same input protocol as the base model.…

[code] itemdefid: 10 type: item name: Sword itemdefid: 11 type: item name: Shield itemdefid: 100 type: generator name: Generator A bundle: 101x1;102x9 tags: color:red itemdef: 101 type: generator name: Generator Legendary bundle: 10;11 tags: quality:legendary itemdef: 102 type: generator name: Generator Common bundle: 10;11 tags: quality:common [/code] Another way to assign tags would be to use the [code-inline]tag_generator[/code-inline] item definition type. …

[/td] [/tr] [tr] [td][b]Event Cover Image[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]800px x 450px - Artwork and marketing copy for your event or announcement [doclink=store/assets/eventassets#cover]See details[/doclink][/td] [/tr] [tr] [td][b]Event Header Image[/b][/td] [td]Optional[/td] [td]1920px wide x 622px - Event artwork and logo. …

[subsection=Background]Background[/subsection] To set the stage, you might start by watching or reading this Steam Dev Days 2016 presentation: [url]https://www.youtube.com/watch?v=7I4SiAiKqqk[/url] [url=http://cdn.akamai.steamstatic.com/apps/steamdevdays/slides2016/SteamController.pdf]Slides - PDF[/url] [url=http://www.gamasutra.com/blogs/LarsDoucet/20161012/283057/Steam_Dev_Days_Steam_Controller.php]Slides - HTML[/url] And for a specific applied example and case study, you should read this article: [url=http://www.gamasutra.com/blogs/LarsDoucet/20170125/289904/The_Steam_Controller_Configurators_Untapped_Power.php]The Steam Controller Configurator's Untapped Power[/url] With those two things under your belt, you're ready to dig into the nitty-gritty details of this document! …

[section]Getting started[/section] The full list of features provided through the SDK is as follows. [list] [*] [b]glmgr[/b] - The "ToGL" DirectX to OpenGL compatibility layer for macOS. See the [url=https://github.com/ValveSoftware/ToGL]ToGL github[/url] page for more information. [*] [b]public/steam[/b] - [doclink=sdk/api][/doclink] [*] [b]redistributable_bin[/b] - Steamworks API redistributable binaries (see the Steamworks API Overview above.) [*] [b]steamworksexample[/b] - [doclink=sdk/api/example][/doclink] [*] [b]tools[/b] [list] [*] [b]ContentBuilder[/b] - [doclink=sdk/uploading][/doclink] [*] [b]ContentServer[/b] - [doclink=sdk/uploading/local_content_server][/doclink] [*] [b]drm[/b] - [doclink=features/drm][/doclink] [*] [b]goldmaster[/b] - [doclink=sdk/goldmaster][/doclink] [*] [b]linux[/b] - Build instructions. …

[/td][/tr] [tr][td][b]unIPServer[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td]The IP of the game server in host order, i.e 127.0.0.1 == 0x7f000001.[/td][/tr] [tr][td][b]usPortServer[/b][/td][td][apitype]steam_api::uint16[/apitype][/td][td]The connection port of the game server, in host order.…

[/td][/tr] [tr][td][b]unIPServer[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td]The IP address of the game server in host order, i.e 127.0.0.1 == 0x7f000001.[/td][/tr] [tr][td][b]usPortServer[/b][/td][td][apitype]steam_api::uint16[/apitype][/td][td]The connection port of the game server, in host order.…

[section]Overview[/section] Steam started as a multiplayer gaming platform with the release of Counter-Strike 1.6 and multiplayer has always been a huge focus. Steam provides many different features and APIs to improve the multiplayer experience for developers and customers alike. …

[docimg=xbox360_controller.png]xbox360_controller.png[/docimg] [subsection=FaceButtons]Face buttons[/subsection] [b]Digital[/b] The Xbox 360 controller features four standard face buttons labeled A, B, X, and Y. [docimg=xbox360_controller_face.png]xbox360_controller_face.png[/docimg] [subsection=Joysticks]Joysticks[/subsection] [b]Analog, 2 axes[/b] (+ digital "click") Like most other gamepads, the Xbox 360 controller features two analog joysticks, on the left and right side, vertically offset. …

Furthermore, if possible the socket will be bound in "dual stack" mode, which means that it can accept both IPv4 and IPv6 client connections. If you really do wish to bind a particular interface, then set the local address to the appropriate IPv4 or IPv6 IP. …

[/list] Return value: [list] [*] k_EResultNoConnection - bad hConn [*] k_EResultInvalidParam - Invalid number of lanes, bad weights, or you tried to reduce the number of lanes [*] k_EResultInvalidState - Connection is already dead, etc [/list] See also: [list] [*] SteamNetworkingMessage_t::m_idxLane [/list] [section=functions_misc]Misc[/section] [subsection=GetListenSocketAddress]GetListenSocketAddress[/subsection] [code=cpp]bool GetListenSocketAddress( HSteamListenSocket hSocket, SteamNetworkingIPAddr *address );[/code] Returns local IP and port that a listen socket created using CreateListenSocketIP is bound to. Specific IPv6/IPv4 addresses may be returned if you bound the socket to a particular interface. An IPv6 address of ::0 means "any IPv4 or IPv6" An IPv6 address of ::ffff:0000:0000 means "any IPv4" NOTE: This is not how you find out your public IP that clients can connect to. …

One instance of this to note is that currently applications that are launched through an app bundle on Apple Silicon devices will launch the best architecture available in the application whereas direct binary launches will use the same architecture as the Steam process (currently x86_64).[/callout] [section]Setting up the SDK for SteamPipe uploads[/section] Download and unzip the latest version of the Steamworks SDK on the machine you will be uploading builds on. …

[h4]Running the app build results in the following error: "ERROR! Failed 'DepotBuild for scriptname.vdf' - status = 6."[/h4] Possible Causes: [list] [*] Account does not have permissions for the app. [list] [*] Check that the app ID is correct in the app_build.vdf. [*] Check that the build account has [doclink=#Build_Account]proper permissions[/doclink] to the app ID. …

A complete list: [list] [*] Left Trigger Full Pull [*] Right Trigger Full Pull [*] Left Trigger Soft Pull* [*] Right Trigger Soft Pull* [*] Left Bumper [*] Right Bumper [*] Left Grip [*] Right Grip [*] Left Pad Click [*] Right Pad Click [*] Left Pad Touch [*] Right Pad Touch [*] Left Joystick Click [*] Right Joystick Click [*] D Pad Up [*] D Pad Down [*] D Pad Left [*] D Pad Right [*] A Button** [*] B Button** [*] X Button** [*] Y Button** [*] Start Button** [*] Select Button** [/list] [i]*Where available - note that Nintendo Switch controllers do not have Analog Triggers[/i] [i]**Actual label will vary between controller models[/i]…