[b]Entitlements[/b] Support for 10.15 (Catalina) requires adding the following entitlements to your build configuration [list][*][code-inline]com.apple.security.cs.disable-library-validation [/code-inline] (allows loading the Steamworks SDK library and overlay library) [*][code-inline]com.apple.security.cs.allow-dyld-environment-variables [/code-inline] (enables the overlay library to be injected into the game process) [/list] [callout=red][b]Note:[/b] Steam is not currently compatible with the [url=https://developer.apple.com/documentation/security/app_sandbox]com.apple.security.app-sandbox[/url] entitlement. …

You can see all packages associated with your application on the [url=https://partner.steamgames.com/apps/associated/]Associated Packages & DLC[/url] page. [*] In the [url=https://partner.steamgames.com/apps/view/]Steamworks Settings for your app[/url], check the appropriate operating system boxes under [b]Supported Operating Systems[/b]. [*] Edit your store page and check the appropriate operating system boxes on the Basic Info tab. [*] Then scroll down and enter the corresponding system requirements. Preview your store page and then publish your changes when you're happy with how the system requirements appear. [*] Finally, return to your Steamworks Settings page and move the build to the Default branch. …

You can set up these links from your game's Steamworks Storefront Admin under the 'Basic Info' tab under the 'External Links' section. [subsection]Who is using your hub?[/subsection] Players find hubs through a variety of channels. …

[/list] [b]Note[/b]: An account must have 'Edit App Metadata' privileges for the app in question in order to edit this section. It's also a good idea to browse other product hubs to get an idea of what customization options you might want to take advantage of. …

As such this API [b]MUST[/b] be called from a secure server, and can never be used directly by clients! [section=GetAppList]GetAppList[/section] [code=http]GET https://api.steampowered.com/ISteamApps/GetAppList/v2/[/code] Deprecated - this API can no longer scale to the number of items available on Steam. Please use [doclink=webapi/IStoreService#GetAppList]IStoreService/GetAppList[/doclink] instead. Gets the complete list of public apps. [section=GetPartnerAppListForWebAPIKey]GetPartnerAppListForWebAPIKey[/section] [code=http]GET https://partner.steam-api.com/ISteamApps/GetPartnerAppListForWebAPIKey/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 publisher authentication key.…

[b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=GetRecentlyPlayedGames]GetRecentlyPlayedGames[/section] [code=http]GET https://partner.steam-api.com/IPlayerService/GetRecentlyPlayedGames/v1/[/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 user authentication key.…

[/td][/tr] [tr][td][b]appids_filter[/b][/td][td]uint32[/td][td]✔[/td][td]if set, restricts result set to the passed in apps[/td][/tr] [/table] Returns a list of games owned by the player if their owned games/game details are visible to you. [section=GetSteamLevel]GetSteamLevel[/section] [code=http]GET https:/partner.steam-api.com/IPlayerService/GetSteamLevel/v1/[/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 user authentication key.…

[b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=SetItemPaymentRules]SetItemPaymentRules[/section] [code=http]POST https://partner.steam-api.com/IWorkshopService/SetItemPaymentRules/v1/[/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 publisher authentication key.…

[/td][/tr] [tr][td][b]gameitemid[/b][/td][td]uint32[/td][td]✔[/td][td][/td][/tr] [/table] Get a list of contributors for a specific app/workshop item combination. [b]NOTE:[/b] This call requires a publisher API key to use this method. …

[/td][/tr] [/table] [b]Response[/b] The output from this method will be a JSON object. [list] [*] [b]response[/b] [list] [*][b]success[/b] - True if the method was successful. If the asset server is returning false, it should set error to a string that explains why. [*][b]error[/b] - a string describing why this call failed. This message will be recorded in the error log, which is available under the Economy tab on the Steamworks site. [*][b]failed [/b] - an array of item definition IDs that were successfully updated by this call. [/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.…

Only the host needs to own and install the game, while additional players connect through Steam Remote Play streaming technology. This feature is enabled automatically for games that are listed with Local Multiplayer, Local Co-op, or Shared/Split Screen capability, but you can enable or disable it yourself to match whether this feature is appropriate for your game. Users can invite friends from their friends list in the Steam overlay, and if you want, you can create UI to invite friends directly from your game using the [api]ISteamRemotePlay::BSendRemotePlayTogetherInvite[/api]() function. …

Call [url=https://partner.steamgames.com/doc/webapi/ISteamMicroTxn]GetUserInfo()[/url] in the ISteamMicroTxn API to get information about the user. Three main responses may be useful in determining how much you trust the user: [list] [*] Country – returns the country where the user is connecting from to make their purchase. …

This status is not always permanent, especially in the case of hijacking or accidental chargebacks by banks. [/olist] [/list] [*]Catching fraudulent transactions before they can impact the economy is important. [list][*]Steam catches most fraudulent transactions within 48 hours of the initial purchase. …

[b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=GetAllApprovalRequests]GetAllApprovalRequests[/section] [code=http]GET https://partner.steam-api.com/IPublishedFileModerationService/GetAllApprovalRequests/v1/[/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 publisher authentication key.…

[section=enums]Enums[/section] These are enums which are defined for use with IPublishedFileModerationService. Values not listed are for internal use only. [subsection=EPublishedFileRevision]EPublishedFileRevision[/subsection] Revisions of a published file's content. …

Follow these steps so that your initial login token is properly saved: [olist] [*] Run "steamcmd.exe +login <username> on the machine that will be preforming the build" [*] Enter your password, and the SteamGuard token [*] Type "info", and you should see your account listed as connected [*] Type "quit" [*] For each future run, do not enter a password. …

Check that the path contains actual content. [/list] [/list] [h4]Running the app build results in the following error: "ERROR! Failed to get application info for app NNNNN (check login and subscription)"[/h4] This means that Steam can't retrieve information about the app, either because it doesn't exist or the user doesn't have access to the app. …

They will continue to be usable but it's highly recommended that you use the latest version. Change history: [list] [*] [b]Version 2[/b] - Fixes returning the leaderboard name in XML. [/list] [b]NOTE:[/b] This call requires a publisher API key to use this method. …

They will continue to be usable but it's highly recommended that you use the latest version. Change history: [list] [*] [b]Version 2[/b] - Fixes returning the leaderboard name in XML. [/list] [b]NOTE:[/b] This call requires a publisher API key to use this method. …

[/list] [section]Frequently Asked Questions[/section] [b]Q: I uploaded contents to my soundtrack depot, but nothing downloads through Steam. …

(DLC requires downloading the base game content before downloading DLC.) [*]Soundtrack content can be surfaced and marketed on the storefront in ways that DLC cannot. [*]The music files will be placed into the Steam library music folder, rather than a subdirectory of your app's install directory. [*]You have access to additional tools to provide album art, high-quality/lossless audio files, etc. [/list] There is a tool to convert an existing DLC app to a soundtrack app that can be accessed through the "Basic Info" tab in the Store Page Admin for your app. …

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

[b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=PostGameDataFrame]PostGameDataFrame[/section] [code=http]POST https://partner.steam-api.com/IBroadcastService/PostGameDataFrame/v1/[/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 publisher authentication key.…

Note: this API is normally used to retrieve metadata about UGC for display purposes, so it is a good practice to keep the list of items small to match your UI. Subscribed items should have enough information to be used, available through: [list] [*][api]ISteamUGC::GetNumSubscribedItems[/api] [*][api]ISteamUGC::GetSubscribedItems[/api] [*][api]ISteamUGC::GetItemState[/api] [*][api]ISteamUGC::GetItemInstallInfo[/api] [/list] [b]NOTE:[/b] Either [code-inline]nConsumerAppID[/code-inline] or [code-inline]nCreatorAppID[/code-inline] must have a valid AppID! …

[subsection=GetItemInstallInfo]GetItemInstallInfo[/subsection] [code=cpp]bool GetItemInstallInfo( PublishedFileId_t nPublishedFileID, uint64 *punSizeOnDisk, char *pchFolder, uint32 cchFolderSize, uint32 *punTimeStamp );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]nPublishedFileID[/b][/td][td][apitype]ISteamRemoteStorage::PublishedFileId_t[/apitype][/td][td]The workshop item to get the install info for.…

k_ESteamNetConnectionEnd_Misc_NoRelaySessionsToClient = 5006, k_ESteamNetConnectionEnd_Misc_Max = 5999, }; [/code] [subsection=SteamNetConnectionInfo_t]SteamNetConnectionInfo_t[/subsection] Describe the state of a connection. [code] struct SteamNetConnectionInfo_t { /// Who is on the other end? …

k_ESteamNetworkingConfig_SDRClient_DebugTicketAddress = 30, /// [global string] For debugging. Override list of relays from the config with /// this set (maybe just one). Comma-separated list. k_ESteamNetworkingConfig_SDRClient_ForceProxyAddr = 31, // // Log levels for debuging information. …

If you have moved to a different country, you will need to retake the tax interview. [/list] [subsection]US TINs[/subsection] [list] [*][h4]Q. Why do I need to obtain an Individual Taxpayer Identification Number (ITIN)?…

[/h4] A. It may take a few months or longer to obtain an ITIN. [/list]…

Interface to get and interact with game server stats. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=GetGameServerPlayerStatsForGame]GetGameServerPlayerStatsForGame[/section] [code=http]GET https://partner.steam-api.com/ISteamGameServerStats/GetGameServerPlayerStatsForGame/v1/[/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 publisher authentication key.…

Provides restricted access to Steam Community features. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=ReportAbuse]ReportAbuse[/section] [code=http]POST https://partner.steam-api.com/ISteamCommunity/ReportAbuse/v1/[/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 publisher authentication key.…

[b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. For more info on how to use the Steamworks Web API please see the [doclink=webapi_overview][/doclink]. [section=Delete]Delete[/section] [code=http]GET https://api.steampowered.com/IPublishedFileService/Delete/v1/[/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 user authentication key.…

[/td][/tr] [tr][td][b]required_flags[/b][/td][td]string[/td][td]✔[/td][td]Required flags that must be set on any returned items[/td][/tr] [tr][td][b]omitted_flags[/b][/td][td]string[/td][td]✔[/td][td]Flags that must not be set on any returned items[/td][/tr] [tr][td][b]search_text[/b][/td][td]string[/td][td]✔[/td][td]Text to match in the item's title or description[/td][/tr] [tr][td][b]filetype[/b][/td][td]uint32[/td][td]✔[/td][td][webapi]IPublishedFileService#EPublishedFileInfoMatchingFileType[/webapi][/td][/tr] [tr][td][b]child_publishedfileid[/b][/td][td]uint64[/td][td]✔[/td][td]Find all items that reference the given item.…