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

This page is intended as an overview of the Steam Workshop and the different models available. For technical details on implementing Steam Workshop with your title, please see the [doclink=features/workshop/implementation][/doclink]. …

[subsection]Integration Work[/subsection] Here are some of the typical components to think about for integration of the Curated Workshop model with your game: [list] [*] [b]Accepting entries from item authors[/b] - You'll need a tool for item authors to upload their entries to your Workshop. …

A [b]mod[/b], short for [b]modification[/b], is an alteration or creation of files within a game that alters aspects such as gameplay, graphics, environments, models, and more. Many of Valve's first-party games come with a software development kit (SDK) to support the creation of mods. The legal guidelines for modding our games are outlined in the [url=https://store.steampowered.com/subscriber_agreement/]Steam Subscriber Agreement[/url] and within the modding tools we provide. …

[/b] The best way to contact us with questions about shipping your mod is by filing a support ticket on https://help.steampowered.com. [/list] [section=TF2FAQ]Team Fortress 2 Mods FAQ[/section] [list] [*] [h4]Q. Where do I get the TF2 SDK?[/h4] [b]A.[/b] The TF2 SDK is part of the Source SDK 2013, which is available on [url=https://github.com/ValveSoftware/source-sdk-2013]Github[/url] or via [url=steam://rungameid/243750]Steam[/url] . [*] [h4]Q. …

You can browse through our license catalog on the [url=https://store.steampowered.com/pccafe/]Steam PC Cafe content page[/url]. With the VR arcade model you will need to purchase game licenses with the station's individual Steam account directly - once purchased, they cannot be transferred or used by another station. …

This is the best choice for highly competitive games (such as Dota 2) or games with persistent servers that stay around after players leave (such as Team Fortress 2). [section]Steam Server Browser[/section] A large part of the game server experience on Steam comes from the unified server browser. …

[section]Example Query[/section] The following example retrieves the 3 most recent news entries for Team Fortress 2. The request specifies that the response should be returned as JSON and includes: a required appid parameter (Team Fortress 2's AppID is 440), and an optional count parameter to limit the number of results returned. …

This is the best choice for highly competitive games (such as Dota 2) or games with persistent servers that keep running even after all players leave (such as Team Fortress 2). You can read more about it in the [doclink=features/multiplayer/game_servers][/doclink] documentation.…

This is the approach used by older Valve Source games such as Team Fortress 2 and Counter-Strike: Source. If you choose OpenGL then we recommend using the core functionality in OpenGL 3.0 for your game. …

The following libraries provide support for other aspects of game development: [list] [*] [url=http://www.freetype.org/index.html]FreeType[/url] - font rendering (both vector-based and bitmap fonts) on Linux [*] [url=http://www.freedesktop.org/wiki/Software/fontconfig]Fontconfig[/url] - configuring and customizing font access [*] [url=http://www.radgametools.com/miles.htm]Miles Sound System[/url] - a middleware sound engine for Linux development [*] [url=http://www.radgametools.com/bnkmain.htm]Bink Video[/url] - a video codec designed for game developers [*] [url=http://www.webmproject.org/]WebM[/url] - an open media file format; used for recording Team Fortress 2 video instead of QuickTime. [/list] [section]Linux Runtime[/section] Titles with native Linux support may select a specific version of the Steam for Linux runtime to execute under. …

These files should be in the AES standard [url=https://www.sofaconventions.org/]SOFA format[/url]. [*] [b]Model occlusion of sound sources.[/b] Steam Audio can quickly model raycast occlusion of direct sound by solid objects. Steam Audio also models partial occlusion for non-point sources, and transmission of occluded sound through the occluding geometry. [*] [b]Model reflections and related environmental audio effects.[/b] Steam Audio can model how sound is reflected by solid objects. This can be used to model many kinds of environmental audio effects, including slap echoes, flutter echoes, occlusion of sound by buildings, and more. [*] [b]Model propagation of sound along multiple paths.…

[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. You can simply put the URL to the model directly into the event body. [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. …

[/list] [h4][url=https://partner.steamgames.com/doc/sitelicense/licensees/gettingstarted/licensemodelpc]Setup instructions for the PC Café model can be found here.[/url][/h4] [/list][/callout] [callout] [list] [*][u][b]VR Arcades Only - Dedicated Steam Account per VR station[/b][/u] This model allows VR arcades to create a dedicated Steam account for each station. …

Since commercial game licenses are purchased with the individual station account, you will also not have access to the Café server features and content cache. [i]VR Arcades may also refer to the recommended setup model.[/i] [h4][url=https://partner.steamgames.com/doc/sitelicense/licensees/gettingstarted/licensemodelvr]Setup instructions for the VR arcade model can be found here.…

[callout]To assist in evaluating performance, we've added a [doclink=steamframe/compat/perf_criteria]Performance Assessment Overlay[/doclink] to SteamVR. [/callout] [/list] [b]Input[/b] [list] [*][b]controller models[/b]: VR games that render controller models must show Frame's controllers. ([i]Recommendations: We recommend using OpenXR's [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_render_model]XR_EXT_render_model[/url] or [url=https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html#XR_EXT_interaction_render_model]XR_EXT_interaction_render_model[/url], or OpenVR's [url=https://github.com/ValveSoftware/openvr/blob/0924064316de3effbcd1acf1e309182a2deb1c05/headers/openvr.h#L4782]IVRRenderModel[/url] interface, for obtaining the controller model mesh at runtime in order to automatically support current and future devices.…

Steam does not contain any paid advertising, nor are advertising models supported in games distributed on Steam. There are varying interpretations for what constitutes ‘advertising’ in a game, so the examples below are meant to help guide developers as to what is and is not supported on Steam. …

[/list] [section]Not Supported[/section] [list] [*]Developers should not utilize paid advertising as a business model in their game, such as requiring players to watch or otherwise engage with advertising in order to play, or gating gameplay behind advertising. …

[h4]Business Model[/h4] Some key formats for monetization on mobile are not received very well by PC players. For instance, PC players seem less willing to put up with microtransaction configurations that hold back gameplay or progress unless you pay. We’ve seen some games that have had that kind of format on mobile switch to a premium model on PC where all the content is unlocked and unrestricted, which seems to work better. Where it makes sense, there are options on Steam to sell additional content as [doclink=store/application/dlc]DLC or expansions[/doclink] but the core game should be a full experience without requiring an additional purchase. …

Sub-inputs: [list] [*] South [*] East [*] West [*] North [/list] [section]Trigger[/section] [docimg=input_trigger.png]input_trigger.png[/docimg] An analog trigger is a single-axis input typically located on the back of the controller, and sensitive to various degrees of pulling. All four major controller models feature exactly two analog triggers. Variations: [list] [*] Left Trigger [*] Right Trigger [/list] Sub-inputs: [list] [*] Analog pull [*] Digital click* [/list] [i]*Of the four major supported controller models, only the Steam Controller supports a discrete digital "click" at the end of a full pull. However, the player can set a threshold in the Steam Input Configurator to emulate this behavior for all other controller models.[/i] [section]Gyro[/section] [docimg=input_gyro.png]input_gyro.png[/docimg] The Steam Controller, PlayStation 4 controller and the recently added PS5 (DualSense) feature internal gyroscopes which allow for motion controls, aim assist, etc. …

It shares certain features with the Steam controller that are lacking in the XInput standard (central trackpad & gyroscope), while hewing to a more traditional twin-stick form factor that some players prefer. *[i]referring here to all compatible models, including but not limited to the DUALSHOCK 4 model[/i] [docimg=ds4_controller.png]ds4_controller.png[/docimg] The PlayStation 4 controller has all the same physical features available to XInput controllers, as well as: [list] [*] A central trackpad [*] An internal gyroscope [*] A programmable LED light bar [/list] [subsection=FaceButtons]Face buttons[/subsection] [b]Digital[/b] The PlayStation 4 controller features four standard face buttons labeled with a SQUARE, a CROSS, a TRIANGLE, and a CIRCLE. …

[docimg=ds4_controller_share_options.png]ds4_controller_share_options.png[/docimg] [callout=green,fixed][b]NOTE[/b]: SHARE and OPTIONS correspond to SELECT and START on previous PlayStation Controller models.[/callout] [subsection=L1R1]L1 and R1 (Shoulder buttons)[/subsection] [b]Digital[/b] The shoulder buttons are pretty standard. …

[callout=red] [b]NOTE:[/b] By default, all configurations for controller models other than the one you're currently using are hidden, but you can select "Show Other Controller Types" to force them to appear. …

In this case, head on over to the "Templates" section, which is full of generic input configurations for each controller model, with many variations for all the most common game genres. [docimg=browse_configs_6.png]browse_configs_6.png[/docimg] …

This is part of an older set of functions designed around the Berkeley TCP sockets model it's preferential that you use the P2P functions, they're more robust and these older functions will be removed eventually. [b]Returns:[/b] int [subsection=GetP2PSessionState]GetP2PSessionState[/subsection] [code=cpp]bool GetP2PSessionState( CSteamID steamIDRemote, P2PSessionState_t *pConnectionState );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]steamIDRemote[/b][/td][td][apitype]steam_api::CSteamID[/apitype][/td][td]The user to get the active session state information of.…

fills out *pcubMsgSize with the size of the next message, in bytes This is part of an older set of functions designed around the Berkeley TCP sockets model it's preferential that you use the P2P functions, they're more robust and these older functions will be removed eventually. [b]Returns:[/b] bool [subsection=IsP2PPacketAvailable]IsP2PPacketAvailable[/subsection] [code=cpp]bool IsP2PPacketAvailable( uint32 *pcubMsgSize, int nChannel = 0 );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pcubMsgSize[/b][/td][td][apitype]steam_api::uint32[/apitype] *[/td][td]Returns the size of the packet.…

[section]Pricing Types[/section] Steam supports multiple business models that games use to price content, whether it be the single purchase of a full game, DLC, in-game microtransactions or recurring subscriptions. …

[b]Q: Does Steam pricing support "paywall" games?[/b] A: No. Steam does not support models where a customer is blocked and needs to pay to continue playing. If you would like to have a free demo to show off your game, you're welcome to do so. …

These files will not be downloaded by users through the Workshop, but will be viewable by the community to rate. This is the implementation that Team Fortress 2 uses. [/list] [/list] [*] Register a call result handler for [apitype]ISteamUGC::CreateItemResult_t[/apitype] [*] First check the [code-inline]m_eResult[/code-inline] to ensure that the item was created successfully. [*] When the call result handler is executed, read the [code-inline]m_nPublishedFileId[/code-inline] value and store for future updates to the workshop item (e.g. in a project file associated with the creation tool). [*] The [code-inline]m_bUserNeedsToAcceptWorkshopLegalAgreement[/code-inline] variable should also be checked and if it's [b]true[/b], the user should be redirected to accept the legal agreement. …

[code=cpp] "workshopitem" { "appid" "480" "publishedfileid" "5674" "contentfolder" "D:\\Content\\workshopitem" "previewfile" "D:\\Content\\preview.jpg" "visibility" "0" "title" "Team Fortress Green Hat" "description" "A green hat for Team Fortress" "changenote" "Version 1.2" } [/code] Notes: [list] [*] The keys map to the various ISteamUGC::SetItem[...] methods. …