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

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

[subsection]What Steam will manage[/subsection] Steam will manage notifying users in a game session based on the states provided by the game and the specific settings that the user has selected for the game. An alert will be displayed in the Steam client and the web browser for the user when action is required for a game. …

[section=Localization]Localization[/section] Localization is provided by the game developer through a localization tool that is part of the application configuration. You are responsible for setting each language translation for every string entered into the localization tool. Any strings that are not translated to a player’s language will be rendered in English. …

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

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

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

For some locations, such as VR Arcades, they typically use their own set of accounts to provide access to games. In those situations, there is no exchange or connection made between the organization's system and your Steam account.…

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

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

Steam has a set of tools for creating and configuring a custom sale landing page that you can use to highlight games for a special sale, game festival, or digital companion for a physical convention. …

[docimg=short_description_example2.jpg]short_description_example2.jpg[/docimg] [subsection]Short Description Best Practices[/subsection] [list] [*][b]Focus on Your Product's Unique Value Proposition[/b] - There are a million things to say about any game, but the short description will need to quickly convey why a customer would want to learn more about [i]this[/i] game in particular. What sets it apart from other games? It's often a good idea to mention the game genre. [*] [b]Save the Details for Later[/b] - The short description is generally not the best place to describe your game's full feature list or its narrative story arc. …

To help maintain this focus, and to minimize clutter across the Store, we maintain the following set of rules for Store Page descriptions: [list] [*][b]No links [/b] - You cannot use your store page descriptions or graphical assets to promote or link to other websites. …

[b][u]GetDetailedSales Best Practices[/u][/b] [u][b]Step 1:[/b][/u] Call GetChangedDatesForPartner to find the set of dates that have new data. Your first call will use a highwatermark value of 0 and will return every date you have ever had sales or activations on Steam. …

[/td] [/tr] [tr][td][b]highwatermark[/b][/td][td]uint64[/td][td]✔[/td][td]A unique identifier, the point at which to query data forward from. Should be set to 0 on first run.[/td][/tr] [tr][td][b]include_view_grants[/b][/td][td]bool[/td][td][/td][td]Include dates that are visible via view grants in the response[/td][/tr] [/table] Retrieves the set of dates for which financial data has changed since the given highwatermark. …

[/introblock] [section]Overview[/section] Partners on Steam are responsible for setting and managing pricing for their products. The Steamworks Developer site provides tools to configure pricing and discounts in all the currencies supported by Steam. …

The following permissions are required for a specific account in order to set or adjust pricing for a product: [list][*]The Steamworks partner that you are a member of must be the partner getting paid for sales of the product. …

[doclink=store/assets/standard#screenshots]See details[/doclink][/td] [/tr] [tr] [td][b]Page Background[/b][/td] [td]Optional[/td] [td]1438px x 810px Subtle artwork, not too bright [doclink=store/assets/standard#page_background]See details[/doclink][/td] [/tr] [tr] [td][b]Bundle Images[/b][/td] [td]Optional[/td] [td][color=#ca5029]Bundle assets required if you set up a bundle[/color] [doclink=store/assets/standard#bundles]See details[/doclink][/td] [/tr] [/table] [subsection]Community and Client Icons[/subsection] [doclink=store/assets/community]Community and Client Icons Details & Templates[/doclink] - These are the capsules and icons needed for the Steam Community and Client presentation of your game. …

[doclink=store/assets/eventassets#header]See details[/doclink][/td] [/tr] [/table] [section=override]Artwork Overrides[/section] Artwork Overrides allow you to upload bespoke capsule images to market something specific in your game, and then have those special images automatically expire after a set timespan. We recommend you use this tool for major game updates, tournaments, or other time-sensitive events. See [doclink=store/assets/overrides]Artwork Overrides[/doclink] documentation for more details …

See: [doclink=store/application/platforms/linux][/doclink] [*] [b]ContentPrep.zip[/b] - Deprecated. This was used to set the correct permissions for macOS applications before SteamPipe became available. [*] [b]SteamPipeGUI.zip[/b] - A [doclink=sdk/uploading#steampipe_gui_tool]SteamPipe GUI Tool[/doclink] for Windows to make uploading simple products even easier. …

[/olist] [subsection=create]Create a Bundle[/subsection] In general, for collaborative bundles, we strongly suggest that they are created with the 'Complete the set' bundle type. This makes it easier to add games to bundle overtime while presenting the easiest to consume version of the bundle. …

Any previous URL will be invalidated. [*][b]Q. I have a bundle with multiple partners' game in it that Valve set up for me, how do I edit it?[/b] A. The owner of the bundle, which is the partner that originally created the bundle, will be able to enable collaboration mode on that bundle and that will allow for future edits to the bundle. …

[section]Enabling the overlay[/section] You can turn on the in-headset performance assessment by opening the SteamVR Dashboard, toggling [b]Advanced Settings[/b] (bottom left corner) to [b]Show[/b], then head to the [b]Developer[/b] tab and enable [b]Draw Performance Assessment in Headset[/b]. …

The rest of the file is a list of frame times leading to the violation of the threshold set with the target frame time. This data is helpful to pick up rapid frame time oscillations that may not be visible on the overlay. …

[docimg=daily_deal_updated.jpg]daily_deal_updated.jpg[/docimg] [section]Daily Deal Eligibility[/section] Since Daily Deals appear prominently in the Steam Store and are visible to broad swaths of customers, we need to have confidence that these offers will be interesting to a broad set of customers. Therefore, we judge eligibility for daily deals based on demonstrated customer interest or trending momentum in revenue over the past few months. …

[/list] [subsection]Visibility & Duration[/subsection] Two or more Daily Deals are displayed on the front page of Steam and may also be featured on appropriate tag pages (RPG, Simulation, VR, etc). From the set of active Daily Deals, Steam will prioritize which ones are surfaced first to each user depending on each players' play history and selected language. …