[/td][/tr] [tr][td][b]steamid[/b][/td][td]uint64[/td][td][/td][td]If specified, only returns details if the file is owned by the SteamID specified[/td][/tr] [tr][td][b]ugcid[/b][/td][td]uint64[/td][td]✔[/td][td]ID of UGC file to get info for[/td][/tr] [tr][td][b]appid[/b][/td][td]uint32[/td][td]✔[/td][td]appID of product[/td][/tr] [/table] [section=SetUGCUsedByGC]SetUGCUsedByGC[/section] [code=http]POST https://partner.steam-api.com/ISteamRemoteStorage/SetUGCUsedByGC/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.…

[/callout] [b]Configuration[/b] To enable the content cache or make any changes, go to "Settings" and select "Content Cache" from the drop down menu. [docimg=settings.png]settings.png[/docimg] When a game is launched for the first time in your network, the download request will be sent to the server machine. …

Modifying files includes uploading new files, uploading new versions of existing files, and deleting files from Steam Cloud. A set of file modification actions should be wrapped in a [b]Batch[/b]. Batches are used to communicate intent to the Steam Cloud for your set of modifications, and help reduce the likelihood of file conflicts. …

[subsection]BeginAppUploadBatch[/subsection] The first operation for a set of file modifications is to call [code-inline]BeginAppUploadBatch[/code-inline]. This call communicates the set of intended uploads and deletes to the SteamCloud, as well as information about the user's machine which is doing the update. …

Users can elect to cancel an agreement at any time from within their Steam account settings. Notification of cancellations will be done through the [webapi]ISteamMicroTxn/GetReport[/webapi] Web API. If your billing agreement is set to the "Game" type, then your backend server will need to the WebAPI [webapi]ISteamMicroTxn/ProcessAgreement[/webapi] to charge the user on each recurring event. …

Submit Your Page For Review[/subsection] Once you've got everything set up, you'll need to submit your sale page for review. The Events team will make sure that you're following all of the guidelines and potentially provide some light feedback on the page organization or art. …

[subsection]Additional Requirements[/subsection] Curated sale pages have additional asset requirements, and take extra time to set up due to localization requirements. If you're seeking curated placement, be sure to reach out at least three months in advance to allow enough time to complete all tasks. …

If you need to transfer a game or other application to another Steamworks partner account, it can be done entirely through a set of tools built into the Steamworks website. These tools manages the approval process and keeps a history of transfers. Transfers may be useful in cases such as when a game changes ownership, or if an individual forms a corporation and needs to move the game to be distributed under the new corporation. …

Please note that only the partner who has payment rights for the game will be able to set pricing and discounts for shared apps. [section]Transfer of Attached Data[/section] All data, including sales, wishlists, followers, user reviews, etc. are associated with the game and will always be associated with the game. …

When you export videos, include color space information and if possible, set the color space to BT.709. This will guarantee that the final video's color matches the color you expect. [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. …

Instead, you'll simply insert the same localized image group into every language that you've translated your post into, and Steam will show the correct image to the viewer depending on their language settings. [section]Accessibility Text[/section] For every image that you place in your written description of your store page, you can add alt text, which will be surfaced to players using screen readers. …

[section=types_of_applications]Types of Applications[/section] The following are the different types of applications that you can create on Steam. You can set the type of your app on the [url=https://partner.steamgames.com/apps/view]General Application Settings[/url] section of the App Admin panel. …

. [*]No images, links, or widgets pointing to other games on Steam - This means that you cannot use your store page description to advertise other products on Steam. If you have related products, you can set up bundles, franchises, or developer homepages.[/list] [/list] [subsection]Under "Special Settings" Tab[/subsection] [list][*]Pinned Bundles - Manage the order of the first bundles that appear on your store page - [url=https://steamcommunity.com/groups/steamworks/announcements/detail/4592070813172257798 ]More Info[/url] [*] Related Games that you make - Control which developer, publisher, or franchise is highlighted below each game’s written description - [url=https://store.steampowered.com/news/group/4145017/view/4578559379959234050]More Info[/url] [*] Feature a DLC - Highlight one item of DLC at the top of the DLC list in a bigger way - [url=https://store.steampowered.com/news/group/4145017/view/4578559379959234050]More Info[/url] [/list] [section]Store Beta Mode[/section] When you are initially creating your store page, or when editing an existing store page, you can see most of your changes in beta mode before making those changes public. …

If you would like to make edits to the store page but do not wish to set it public yet, you can do so by clicking "Save" at the bottom of the page and not publishing those changes. There will be a red bar at the top of the page if there are unpublished changes for the app's store page. …

NOT THREADSAFE - Ensure that no other threads are accessing Steamworks API when calling! [subsection=SetLocalIPBinding]SetLocalIPBinding[/subsection] [code=cpp]void SetLocalIPBinding( uint32 unIP, uint16 usPort );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unIP[/b][/td][td][apitype]steam_api::uint32[/apitype][/td][td]The local IP to bind to.[/td][/tr] [tr][td][b]usPort[/b][/td][td][apitype]steam_api::uint16[/apitype][/td][td]The port to bind to.[/td][/tr] [/table] Set the local IP and Port to bind to. This must be set before calling [api]ISteamClient::CreateLocalUser[/api]! [subsection=SetWarningMessageHook]SetWarningMessageHook[/subsection] [code=cpp]void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pFunction[/b][/td][td]SteamAPIWarningMessageHook_t[/td][td]Function pointer to the callback function.…

[/olist] [section=Permissions]Required Permissions For Editing Anti-Cheat Policies[/section] [b]Who can set or edit Anti-Cheat policies for my product?[/b] Only certain publisher accounts have the necessary permissions to enable or adjust anti-cheat policies for your products on Steam. …

The following permissions are required for a specific account in order to set or adjust anti-cheat policies for a product: [list] [*] Your account must have the specific permission: "Manage Signing" for the product in question. …

[b]Returns:[/b] [apitype]steam_api::uint32[/apitype] The number of events copied to pInput, or the number of events available if pInput is nullptr. [subsection=SetMouseVisibility]SetMouseVisibility[/subsection] [code=cpp]void SetMouseVisibility( RemotePlaySessionID_t unSessionID, bool bVisible );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unSessionID[/b][/td][td][apitype]ISteamRemotePlay::RemotePlaySessionID_t[/apitype][/td][td]The session to affect.…

[subsection=SetMousePosition]SetMousePosition[/subsection] [code=cpp]void SetMousePosition( RemotePlaySessionID_t unSessionID, float flNormalizedX, float flNormalizedY );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unSessionID [/b][/td][td][apitype]ISteamRemotePlay::RemotePlaySessionID_t[/apitype][/td][td]The session to affect.…

You can install Linux and Steam on a machine to test, or request a developer kit once they are available (limited quantities). Once you are set up in your Linux environment / developer kit, you will be able to use the provided debugging tools to run game builds through a remote debugger and profile performance. …

For the Kamu version of EAC, follow these steps in order: [olist] [*]Go into the SDK Configuration settings menu on the EAC partner site and enable Linux as a client platform. [*]Go into the Client Module Releases menu on the EAC partner site, choose the Unix platform, and activate a module. …

[subsection=SetCloudEnabledForApp]SetCloudEnabledForApp[/subsection] [code=cpp]void SetCloudEnabledForApp( bool bEnabled );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]bEnabled[/b][/td][td]bool[/td][td]Enable ([b]true[/b]) or disable ([b]false[/b]) the Steam Cloud for this application?…

This is typically accomplished with a checkbox within your in-game options. [subsection=SetSyncPlatforms]SetSyncPlatforms[/subsection] [code=cpp]bool SetSyncPlatforms( const char *pchFile, ERemoteStoragePlatform eRemoteStoragePlatform );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]pchFile[/b][/td][td]const char *[/td][td]The name of the file.…

This series of documentation describes the set of tools for building and running sale events on Steam. [subsection]Hosting events on Steam[/subsection] If you are looking for information on hosting a sale event on Steam, please see [doclink=store/promo/organizers][/doclink] [subsection]Getting Started With Sale Editor Tools[/subsection] The best place to start with familiarizing yourself with the sale page editing tools is this overview page here: [doclink=marketing/event_tools/sales/tools][/doclink] For more details on various topics within the sale page editors, please see the following documentation: [list] [*][doclink=marketing/event_tools/sales/groups][/doclink] [*][doclink=marketing/event_tools/sales/livestream][/doclink] [*][doclink=marketing/event_tools/sales/minimum][/doclink] [*][doclink=marketing/event_tools/sales/sections][/doclink] [/list] …

[/subsection] This quick review process checks to help properly categorize your event and to confirm that any necessary mature content settings are appropriately applied. While awaiting moderation, you'll see this note on your event detail page where the visibility stats appear: [docimg=ModerationNote.jpg]ModerationNote.jpg[/docimg] Please note that if you make edits to your post, it will re-enter the moderation queue. …

This page displays the first trailer available on the game's store page, based on any language or country restrictions set for the trailers. [docimg=Example_1.png]Example_1.png[/docimg] [subsection]See your game's page[/subsection] By adding the appID to the end of a URL, you can easily view and share this page for any of your games that are Steam Deck Verified. …

[/td] [/tr] [tr] [td][b]Edit Store Localization Data[/b][/td] [td]Grants permission to edit any data on store setting tabs that include one or more localizable fields, such as product description and graphical assets. Does not grant permission to publish, or marketing tools like visibility rounds. …

This will enable management of [doclink=features/anticheat]Anti-Cheat[/doclink] and [doclink=features/auth#encryptedapptickets] SDK Auth[/doclink] settings for an Application.[/td] [/tr] [tr] [td][b]Economy/Workshop Support[/b][/td] [td]Allows the user to view/grant economy items in the partner site economy support tool.…

Getting documents correct the first time will help speed up the process of verifying your identity for setting up your Steamworks partner account. Here are some best practices to help guide you. [section]Taking a good selfie[/section] Many of our identity validation steps involve sending us a photo of yourself holding your legal identity document. …

However, when the user goes to your library page, we also look for any event with the "Featured Event" flag set. We will show the newest of those above all of the chronologically displayed events. It will appear there until the user has seen it, at which point it will stay there for 48 hours before moving to the correct spot in the chronological list. [b]Enabling "Featured Event" flag[/b] To force your event to be pinned to the top of your game's library page, select the "Options" tab for your event and toggle on the setting labeled "Display as a Featured Event on the Library Game Detail page?" [section]Exceptions[/section] For the most part, all events appear in all places, but there are some exceptions for certain kinds of events that don't make sense to show to players in certain contexts. …