[/list] [subsection=SetHTTPRequestRawPostBody]SetHTTPRequestRawPostBody[/subsection] [code=cpp]bool SetHTTPRequestRawPostBody( HTTPRequestHandle hRequest, const char *pchContentType, uint8 *pubBody, uint32 unBodyLen );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]hRequest[/b][/td][td][apitype]ISteamHTTP::HTTPRequestHandle[/apitype][/td][td]The request handle to set the post body on.[/td][/tr] [tr][td][b]pchContentType[/b][/td][td]const char *[/td][td]Sets the value of the calls "content-type" http header.[/td][/tr] [tr][td][b]pubBody[/b][/td][td][apitype]steam_api::uint8[/apitype] *[/td][td]The raw POST body data to set.…

If you include the state parameter, it will be passed back to the redirect URI after the user has confirmed or denied access. Note that the authorization code grant type is also supported, by using the response_type=code during login. If the user grants access, they will be redirected back to you at [code]http://redirect/uri/here#access_token=token_here&token_type=steam&state=whatever_you_want[/code] The token should be treated as an opaque string. …

Unless others noted below, requests should be HTTP POST requests presented as form data and should set this header: [code]Content-Type: application/x-www-form-urlencoded[/code] [Section=RetrieveSteamID]Retrieving the User's SteamID[/Section] Once you have an OAuth token for a user, you can make a server to server call to securely get the SteamID for the user associated with that token by calling: [code]https://api.steampowered.com/ISteamUserOAuth/GetTokenDetails/v1/?…

[/callout] The file must contain a dictionary named [b]steam_frame[/b] and one or more of the following entries: [table] [tr] [th]Name[/th] [th]Value / Type[/th] [th]Corresponding Video -> Per-Application Video Settings menu entry[/th] [th]Behavior when not specified[/th] [/tr] [tr] [td]preferResolution[/td] [td]<integer>, width component[/td] [td]Resolution Per Eye[/td] [td]Use 1728x1728[/td] [/tr] [tr] [td]preferMinRefreshRate[/td] [td]<integer>[/td] [td]Frame Limit / Refresh Rate Override[/td] [td]Use 72 Hz[/td] [/tr] [tr] [td]preferHalfFramerate[/td] [td]true, false[/td] [td]Frame Limit / Throttling Behavior[/td] [td]No throttling[/td] [/tr] [tr] [td]preferMotionSmoothingMode[/td] [td]"off", "on", "alwaysOn"[/td] [td]Motion Smoothing[/td] [td]Use global setting under Video -> Motion Smoothing[/td] [/tr] [/table] [callout=red]JSON syntax can be prone to errors. …

Example [b]vrpreferences.json[/b]: [code=json] { "steam_frame": { "preferResolution": 2160, "preferMinRefreshRate": 90, "preferHalfFramerate": true, "preferMotionSmoothingMode": "off" } } [/code] This example file suggests: [list] [*]A default resolution of 2160x2160 [*]A default display refresh rate of 90 Hz [*]A default frame throttling to 1/2 (Frame Limit to 45 FPS) [*]A default override to disable Motion Smoothing [/list] To validate that the [b]vrpreferences.json[/b] is picked up by SteamVR, the [b]vrserver.txt[/b] log file can be searched: [code=plain] [Info] - [Settings] Loading app-provided preferences from '/home/steamos/.local/share/Steam/steamapps/common/<game folder>/vrpreferences.json' [/code] Parsing errors will be reported in this log, for example: [code=plain] [Info] - Parsing of JSON file "/home/steamos/.local/share/Steam/steamapps/common/[...]…

[list] [*] [code-inline]1[/code-inline] - USD / United States Dollar [*] [code-inline]2[/code-inline] - GBP / United Kingdom Pound [*] [code-inline]3[/code-inline] - EUR / European Union Euro [*] [code-inline]4[/code-inline] - CHF / Swiss Francs [*] [code-inline]5[/code-inline] - RUB / Russian Rouble [*] [code-inline]6[/code-inline] - PLN / Polish Złoty [*] [code-inline]7[/code-inline] - BRL / Brazilian Reals [*] [code-inline]8[/code-inline] - JPY / Japanese Yen [*] [code-inline]9[/code-inline] - NOK / Norwegian Krone [*] [code-inline]10[/code-inline] - IDR / Indonesian Rupiah [*] [code-inline]11[/code-inline] - MYR / Malaysian Ringgit [*] [code-inline]12[/code-inline] - PHP / Philippine Peso [*] [code-inline]13[/code-inline] - SGD / Singapore Dollar [*] [code-inline]14[/code-inline] - THB / Thai Baht [*] [code-inline]15[/code-inline] - VND / Vietnamese Dong [*] [code-inline]16[/code-inline] - KRW / South Korean Won [*][strike][code-inline]17[/code-inline] - TRY / Turkish Lira[/strike] [*] [code-inline]18[/code-inline] - UAH / Ukrainian Hryvnia [*] [code-inline]19[/code-inline] - MXN / Mexican Peso [*] [code-inline]20[/code-inline] - CAD / Canadian Dollars [*] [code-inline]21[/code-inline] - AUD / Australian Dollars [*] [code-inline]22[/code-inline] - NZD / New Zealand Dollar [*] [code-inline]23[/code-inline] - CNY / Chinese Renminbi (yuan) [*] [code-inline]24[/code-inline] - INR / Indian Rupee [*] [code-inline]25[/code-inline] - CLP / Chilean Peso [*] [code-inline]26[/code-inline] - PEN / Peruvian Sol [*] [code-inline]27[/code-inline] - COP / Colombian Peso [*] [code-inline]28[/code-inline] - ZAR / South African Rand [*] [code-inline]29[/code-inline] - HKD / Hong Kong Dollar [*] [code-inline]30[/code-inline] - TWD / New Taiwan Dollar [*] [code-inline]31[/code-inline] - SAR / Saudi Riyal [*] [code-inline]32[/code-inline] - AED / United Arab Emirates Dirham [*] [strike][code-inline]33[/code-inline] - SEK / Swedish Krona[/strike] [*] [strike][code-inline]34[/code-inline] - ARS / Argentine Peso[/strike] [*] [code-inline]35[/code-inline] - ILS / Israeli New Shekel [*] [strike][code-inline]36[/code-inline] - BYN / Belarusian Ruble[/strike] [*] [code-inline]37[/code-inline] - KZT / Kazakhstani Tenge [*] [code-inline]38[/code-inline] - KWD / Kuwaiti Dinar [*] [code-inline]39[/code-inline] - QAR / Qatari Riyal [*] [code-inline]40[/code-inline] - CRC / Costa Rican Colón [*] [code-inline]41[/code-inline] - UYU / Uruguayan Peso [*] [strike][code-inline]42[/code-inline] - BGN / Bulgarian Lev[/strike] [*] [strike][code-inline]43[/code-inline] - HRK / Croatian Kuna[/strike] [*] [strike][code-inline]44[/code-inline] - CZK / Czech Koruna[/strike] [*] [strike][code-inline]45[/code-inline] - DKK / Danish Krone[/strike] [*] [strike][code-inline]46[/code-inline] - HUF / Hungarian Forint[/strike] [*] [strike][code-inline]47[/code-inline] - RON / Romanian Leu[/strike] [/list] …

The tax interview takes 5-10 minutes and will ask you a series of questions to guide you through the completion of either tax forms (W-9 or W-8BEN). You can also access the tax interview by clicking on the “View and edit company information” from the Steamworks home page. …

In order to exercise the benefits under the tax treaty, you will need to complete a Form W-8BEN and that requires either a foreign TIN or a US TIN. Countries that have tax treaties with the U.S. can be found here: https://www.irs.gov/Businesses/International-Businesses/United-States-Income-Tax-Treaties-A-to-Z If your country of residence is Slovakia, you will need to provide a US TIN in completing the Form W-8BEN to claim tax treaty benefits and apply an exempt withholding rate. …

Exchange recipes are evaluated atomically by the Inventory Service; if the supplied components do not match the recipe, or do not contain sufficient quantity, the exchange will fail. For example: [code]exchange: 101x1,102x1;103x5;104x3,105x3[/code] Will allow the item to be exchanged for either one #101 and one #102, five #103s or three #104s and three #105s. …

There is no reason to call this function if your game hardcoded the numeric definition IDs (e.g. purple face mask = 20, blue weapon mod = 55) and does not allow for adding new item types without a client patch. [b]Returns:[/b] bool Triggers a [apitype]ISteamInventory::SteamInventoryDefinitionUpdate_t[/apitype] callback. …

Citizens and corporations in a [url=https://www.irs.gov/businesses/international-businesses/united-states-income-tax-treaties-a-to-z ]country with US tax treaty status[/url] will need information similar to that found on form [url=http://www.irs.gov/pub/irs-pdf/fw8ben.pdf]W-8BEN[/url]. All required information is necessary to get you set up in Steamworks. [callout][b]Note:[/b] Once you submit your tax information, it is verified with a third party service. …

In particular, certain kinds of adult only content. [/olist] [b]Accepted types of content[/b] We are primarily accepting games for distribution on Steam. Non-game software may be accepted for distribution if it fits into one of the following categories: [list] [*] Animation & Modeling [*] Audio/Video Production [*] Design & Illustration [*] Photo Editing [*] Educational & Tutorials [*] Finance & Accounting [*] Player Tools [*] SteamVR Tools (Drivers, Overlays, Utilities) [/list] [section]Next Steps[/section] After you have completed onboarding, check out the rest of the documentation for information on managing your partner account, exploring the SDK, and setting up your first product on Steam.…

[list] [*] "[b]name[/b]" to retrive the localized achievement name in UTF8 [*] "[b]desc[/b]" to retrive the localized achievement description in UTF8 [*] "[b]hidden[/b]" for retrieving if an achievement is hidden. …

[/td][/tr] [/table] Returns the display type of a leaderboard handle. [b]Returns:[/b] [apitype]ISteamUserStats::ELeaderboardDisplayType[/apitype] The display type of the leaderboard. …

[b]Note: We are currently working on updated APIs to help game developers detect the type of hardware their game is running on.[/b] More on that soon, but we would like to emphasize that while providing default graphics options for specific hardware (like Steam Deck) is fine, we recommend against restricting access to settings based on specific hardware. …

If you use an engine like Unity or Unreal, enabling Vulkan in your build for all users will result in the highest performance/longevity. (Note: Proton includes a DirectX-to-Vulkan translation layer. If your game or engine has high-quality DirectX support but no Vulkan support, it's likely that this automated translation layer will exceed the performance of doing a custom Vulkan implementation.) [*][b]Video/Audio Codecs[/b]: We recommend using standalone codecs (eg., VP9 or AV1) rather than codecs that are tied to a specific vendor (eg., WMF). …

Even worse, it uses absolute byte-offset values. So if an asset at byte 3450 increases in size by 8 bytes, then the offset values for all assets after this in the file change. Even though each offset value is only 4 or 8 bytes in size, a change to an 8-byte number will result in a new 1MB chunk being created by SteamPipe. …

[subsection]SteamCmd on macOS[/subsection] To enable SteamCmd on macOS you must complete the following steps: [olist] [*] From the terminal, browse to the tools\ContentBuilder\builder_osx [*] Run chmod +x steamcmd [*] Type bash ./steamcmd.sh [*] SteamCmd will then run and update to the latest build, leaving you in the SteamCmd prompt [*] Type exit and press return to exit the prompt [/olist] You can then follow the rest of this documentation (substituting paths as appropriate) to create depot and app config files for uploading your content to Steam. …

[/list] [/list] [b]Example code[/b] [code] curl --request POST \ --header "Content-Type: application/x-www-form-urlencoded" \ --form appid=30400 \ --form 'itemdefs=[{"appid":"30400","itemdefid":"418","type":"item","display_type":"bag","name":"Bag of Stuff","description":"This bag contains stuff.","background_color":"993300","tradable": true,"marketable": true,"commodity": true,"tags":"class:human;type:bag"}, {"appid": "30400","itemdefid":"403","type":"item","display_type":"cat","name":"Cat of Bags","description":"This cat contains multitudes.…

[callout][b]NOTE[/b]: The [doclink=features/overlay]Steam Overlay[/doclink] must be active in your game for the Screenshots system to be available.[/callout] Users can press a hotkey controlled by Steam (F12 by default), to trigger a screenshot. The user can change the hotkey and other screenshot settings that will take effect in any game they play in Steam by going to Settings -> In-Game. …

Once you see the chat, you can click on any line of chat to bring up the moderation tools: [list][*]Remove this user's messages [*]Mute user for 12 hours [*]Mute user for a week [*]Mute user permanently [*]Unmute [*]Make this user a Moderator [*]Remove Moderator status for user[/list] [subsection]Store page[/subsection] From your Steam store page, click on Show Chat underneath your broadcast to view the chat. …

[/td][/tr] [tr][td][b]pszPreviewFile[/b][/td][td]const char *[/td][td]Absolute path to the local image.[/td][/tr] [tr][td][b]type[/b][/td][td][apitype]ISteamUGC::EItemPreviewType[/apitype][/td][td]The type of this preview.[/td][/tr] [/table] Adds an additional preview file for the item. …

[/td][/tr] [tr][td][b]eFileType[/b][/td][td][apitype]ISteamRemoteStorage::EWorkshopFileType[/apitype][/td][td]The type of UGC to create.[/td][/tr] [/table] Creates a new workshop item with no content attached yet. …

In cases where an API key is required, it can be provided either as a standard parameter or by setting the 'x-webapi-key' request header value. [section=user-keys]User Keys[/section] The standard user keys are available to everyone, all that is required is a Steam account and the domain name that will be associated with this key. …

See the [url=https://partner.steamgames.com/doc/webapi]Steamworks Web API reference[/url] to determine what permission is required for each method. [*]IP Whitelist - Each publisher key can also be locked to a specific set of calling IP addresses. [/list] The four types of Web API Key Permissions are: [list][*]Microtransactions for initializing, finalizing, and reconciling in-game purchases. [*]Sales Data calls to the IPartnerFinancialService API. [*]Economy calls for games that use the Steam Inventory Service. [*]General API calls for things like authenticating a user or checking ownership of a DLC-- everything not included in the above three permissions. …

. [*]On PC: [b]adb connect frame[/b] [*]On PC: Open [b]RenderDoc[/b] and in the lower left hand corner select the [b]Android 5.x [/b]device [*]On PC: [b]adb install[/b] your app [*]On PC: In [b]RenderDoc [/b]under [b]Launch Application[/b] select the executable path for your app. …

[list] [*]Add your title with the SteamOS Devkit Client [*]Remote into your Steam Frame using the instructions in the Remote Desktop section above. [*]Then click the Application Launcher in the lower-left, type: renderdoc, and click to launch. [*]After launching, you can right-click on the icon and pin it for future ease of access. [*]From there you can [b]File > Attach to Running Instance[/b]. …

[subsection=CreateLocalUser]CreateLocalUser[/subsection] [code=cpp]HSteamUser CreateLocalUser( HSteamPipe *phSteamPipe, EAccountType eAccountType );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]phSteamPipe[/b][/td][td][apitype]ISteamClient::HSteamPipe[/apitype] *[/td][td][/td][/tr] [tr][td][b]eAccountType[/b][/td][td][apitype]steam_api::EAccountType[/apitype][/td][td][/td][/tr] [/table] Create a Steam user that won't be shared with anyone else. …

[b]Example:[/b] [code=cpp]extern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText ) { ::OutputDebugString( pchDebugText ); if ( nSeverity >= 1 ) { // place to set a breakpoint for catching API errors int x = 3; x = x; } } void EnableWarningMessageHook() { SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook ); }[/code] [section=typedefs]Typedefs[/section] These are typedefs which are defined for use with ISteamClient. …

The calls are primarily used to pass information to the Steam Timeline UI [callout][b]NOTE:[/b] The overlay is automatically disabled for 'Software' app types. If you need the overlay enabled, you can do so by: [olist] [*]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 [/olist] [/callout] [section=activating]Integrating Steam Timeline functionality in your app[/section] The Steam Timeline API calls can be found here: [api]ISteamTimeline[/api] [section=icons]Timeline Icons[/section] Steam Timelines includes a set of icons ready to use for your game. …

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][b]Header Capsule[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]920px x 430px Just your game logo and artwork [doclink=store/assets/standard#header_capsule]See details[/doclink][/td] [/tr] [tr] [td][b]Small Capsule[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]462px x 174px Just your game logo and artwork [doclink=store/assets/standard#small_capsule]See details[/doclink][/td] [/tr] [tr] [td][b]Main Capsule[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]1232px x 706px Just your game logo and artwork [doclink=store/assets/standard#main_capsule]See details[/doclink][/td] [/tr] [tr] [td][b]Vertical Capsule[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]748px x 896px Just your game logo and artwork [doclink=store/assets/standard#hero_capsule]See details[/doclink][/td] [/tr] [tr] [td][b]Screenshots[/b][/td] [td][color=#ca5029]Required[/color][/td] [td]minimum of 1920px x 1080px or larger, 16:9 ratio. …

[table] [tr] [td][b]Event Cover[/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[/b][/td] [td]Optional[/td] [td]1920px wide x 622px Event artwork and logo. …

</p><br>", "feedlabel": "TF2 Blog", "date": 1495218420, "feedname": "tf2_blog", "feed_type": 0, "appid": 440 } ], "count": 2385 } } [/code] [/list] [*] [h4]XML[/h4] [list] [*] XML Attributes are not used. [*] Arrays are represented as a series of sub-elements in the containing element of the type of the array. [*] Null is represented by the word "null" between the element's tags. [*] [b]Example[/b]: [code=xml] <?…

</p><br></contents> <feedlabel>TF2 Blog</feedlabel> <date>1495218420</date> <feedname>tf2_blog</feedname> <feed_type>0</feed_type> <appid>440</appid> </newsitem> </newsitems> <count>2385</count> </appnews> [/code] [/list] [*] [h4]VDF (Valve Data Format)[/h4] [list] [*] This is Valve's internal data format as used in the Source Engine games. …