[table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_eResult[/b][/td][td][apitype]steam_api::EResult[/apitype][/td][td]The result of the operation. Possible values: [list] [*] [apitype]steam_api::k_EResultOK[/apitype] - Success [*] [apitype]steam_api::k_EResultInvalidParam[/apitype] - This application is not a video and cannot be streamed. [*] [apitype]steam_api::k_EResultFileNotFound[/apitype] - This video has not been processed for streaming. [*] [apitype]steam_api::k_EResultAccessDenied[/apitype] - The video could not be accessed. Please ensure the account you are logged in with owns this video. [*] [apitype]steam_api::k_EResultNoConnection[/apitype] [apitype]steam_api::k_EResultServiceUnavailable[/apitype] - The video service is not available. [*] [apitype]steam_api::k_EResultTimeout[/apitype] - This video is not currently available to stream. [*] [apitype]steam_api::k_EResultBlocked[/apitype] - Sorry, this video is not yet available to watch. …
[/td][/tr] [/table] Allows you to react to a page wanting to open a file load dialog. [callout=red,fixed][b]NOTE:[/b]You MUST call this in response to a [apitype]ISteamHTMLSurface::HTML_FileOpenDialog_t[/apitype] callback.…
[subsection=ViewSource]ViewSource[/subsection] [code=cpp]void ViewSource( HHTMLBrowser unBrowserHandle );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]unBrowserHandle[/b][/td][td][apitype]ISteamHTMLSurface::HHTMLBrowser[/apitype][/td][td]The handle of the surface to view its current pages source.[/td][/tr] [/table] Open the current pages HTML source code in default local text editor, used for debugging. [section=callbacks]Callbacks[/section] These are callbacks which can be fired by calling [api]steam_api::SteamAPI_RunCallbacks[/api]. …
This page contains technical details on implementing Steam Workshop with your title. For information and definitions of the various types of Workshop integration you can utilize and how to make the best out of the tools provided by Steam please see the [doclink=features/workshop]Steam Workshop Overview[/doclink] before getting started integrating the steam workshop with your game. …
[subsection=WorkshopVisibility]Managing Steam Workshop Visibility[/subsection] The Steam Workshop is the website hosted through Steam that enumerates shared content and allows users to vote and comment on the content visible through the community. …
In response, a call to [api]ISteamNetworking::AcceptP2PSessionWithUser[/api] needs to be made, if you want to open the network channel with them. [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_steamIDRemote[/b][/td][td][apitype]steam_api::CSteamID[/apitype][/td][td]The user who wants to start a P2P session with us.…
[table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]m_bConnectionActive[/b][/td][td][apitype]steam_api::uint8[/apitype][/td][td]Do we have an active open connection with the user ([b]true[/b]) or not ([b]false[/b])?[/td][/tr] [tr][td][b]m_bConnecting[/b][/td][td][apitype]steam_api::uint8[/apitype][/td][td]Are we currently trying to establish a connection with the user ([b]true[/b]) or not ([b]false[/b])?…
[section]Event Impression Locations[/section] Here is a quick run-down of what each location refers to: [list] [*][b]Library Home Page Impressions[/b] - This is when your event appears in the row of "What's New" section at the top of the Steam Library Home. Not all of your customers will see your event, as they may not sign in to Steam during the time where your event is valid, or they may have many other games posting events around the same time. …
[/b] A: Impressions are only counted when the event capsule is viewed on the Steam Library, Store, or Community site. If a user discovers your event outside of Steam and visits your event page directly, it will count as a read without generating a corresponding impression. …
v=eYKfnWtQSaQ]video[/url] as an example. [callout=red] [h3]Warning[/h3] Although Steam Input re-scales the mouse position proportionally with resolution, many games do not apply consistent proportional scaling to their GUI elements. …
[list] [*] [b]Default User Setting[/b] No change to how the light functions [*] [b]Default XInput Slot Number Setting[/b] Slots 1-4 are colored red, blue, green, and purple, respectively. [*] [b]Custom Setting[/b] [list] [*][b]Controller Light Color[/b] Change the color of the light [*][b]Controller Light Saturation[/b] Change the intensity of the light [/list] [/list] [subsection]Music[/subsection] [docimg=legacy_music.png]legacy_music.png[/docimg] This lets you control music playback from your Steam music player. Options include: [list] [*] [b]STEAM MUSIC PLAY/PAUSE[/b] [*] [b]STEAM MUSIC NEXT[/b] [*] [b]STEAM MUSIC PREVIOUS[/b] [*] [b]STEAM MUSIC VOLUME UP[/b] [*] [b]STEAM MUSIC VOLUME DOWN[/b] [*] [b]STEAM MUSIC MUTE[/b] [/list] [subsection]Empty[/subsection] [docimg=legacy_empty.png]legacy_empty.png[/docimg] This does nothing, and is used for clearing out a previously selected special action.…
issueid=938]Submission Form[/url]. This will automatically open a ticket with the Steam Events Team, who will review your proposal and confirm your agreement to the [doclink=/store/promo/organizers#10]Event Hosting Rules[/doclink] outlined below. …
[/callout] [callout][b]Remember Your Ticket Number[/b] - If your ticket with the Steam Team ever auto-closes due to inactivity, please open a new ticket and reference the old ticket number so a member of the Steam Team can reopen the original for you. …
[section]Overview[/section] Users who have recorded playtime on your product on Steam can write reviews to indicate whether they recommend your product to others. These reviews may appear on your product's store page and in the Steam Community, depending on how many other users find them helpful. …
Customers may write a review for any product they have launched via Steam. Whether that customer registered a Steam key obtained elsewhere, participated in a Steam Free Weekend, played a Free game, or played a game via Family Library Sharing, they will be able to write a review for your product if they have playtime. …
[section]A practical example[/section] Imagine a class-based shooter with vehicles. This game has native Steam Input support and makes use of action set layers. For basic gameplay, a base action set is always active and covers running around, picking up items, jumping, etc. …
[docimg=action_set_layers_scope.png]action_set_layers_scope.png[/docimg] [code=cpp] void useScope(bool entering) { if(entering) { SteamInput()->ActivateActionSetLayer( controllerHandle1, scopeHandle ); //apply the scoped-in layer when you scope in } else { SteamInput()->DeactivateActionSetLayer( controllerHandle1, scopeHandle ); //remove the scoped-in layer when you lower the scope } } [/code] Here's how all the layers combine. …
[callout] [b]Steam PC Café Server[/b] The Steam PC Café Server allows licensees of the Steam PC Café Program to share commercial licenses in their local network. …
Once added, you will be able to assign it to a site location. A server account is basically a Steam account that does not own anything. [*][i]What ports are being used by the Steam PC Café Server?[/i] The Steam PC Café Server uses UDP broadcast packets over port 27036 to announce itself to Steam clients on the network. …
Sometimes games made by different developers have common themes and can benefit from co-marketing. Including those games in the bundle make it easier for Steam customers to acquire those related titles. This document outlines the steps required to create a collaborative bundle on Steam that contains games from multiple developers/publishers. …
Be thoughtful about which bundles you include your games in; as those invited do not have input via Steam to the description or artwork. [*][b]Q. Does Steam Email me when approval is required?[/b] A. No. Steam does not send any emails related to bundle state or bundle publishing. …
appid=[your app id] [/code] SteamOS devices: Use the [code-inline]Get Controller Config[/code-inline] command in the devkit tool (on the default Devkits tab - see [doclink=steamdeck/loadgames][/doclink] Linux Commandline (requires desktop mode on SteamOS devices): [code] xdg-open steam://dumpcontrollerconfig?…
" ); } char rgchFullPath[1024]; #if defined(_WIN32) _snprintf( rgchFullPath, sizeof( rgchFullPath ), "%s\\%s", rgchCWD, "steam_input_manifest.vdf" ); #elif defined(OSX) _snprintf( rgchFullPath, sizeof( rgchFullPath ), "%s/steamworksexample.app/Contents/Resources/%s", rgchCWD, "steam_input_manifest.vdf" ); #else _snprintf( rgchFullPath, sizeof( rgchFullPath ), "%s/%s", rgchCWD, "steam_input_manifest.vdf" ); #endif SteamInput()->SetInputActionManifestFilePath( rgchFullPath ); [/code]…
[b][code-inline]*[/code-inline][/b] To define the string to display in Steam friends list and chat, set the [code-inline]steam_display[/code-inline] key/value in [url=https://partner.steamgames.com/doc/api/ISteamFriends#SetRichPresence]SetRichPresence[/url]. …
"#StatusWithScore" : "#StatusWithoutScore" ); // Sample of grouping friends together when they play together if ( nPartyMemberCount > 1 && strPartyID ) { // If we're in a party of more than one user, and we have a valid PartyID then // inform Steam's Rich Presence system. steamapicontext->SteamFriends()->SetRichPresence( "steam_player_group", strPartyID ); steamapicontext->SteamFriends()->SetRichPresence( "steam_player_group_size", CNumStr( nPartyMemberCount ) ); } else { // Otherwise, clear out whatever information we had there before; we're not in a party. …
[section]Overview[/section] The Steamworks API allows your game to take full advantage of Steam by accessing all of the underlying systems provided through the API. This includes things such as pausing your game when the user opens the [doclink=features/overlay]Steam Overlay[/doclink], inviting friends to play, allowing players to unlock [doclink=features/achievements]Steam Achievements[/doclink], letting players compete on the [doclink=features/leaderboards]Steam Leaderboards[/doclink] and much more. …
[b]NOTE:[/b] If some of the software you are shipping on steam is available under a restrictive open source license then please see [doclink=sdk/uploading/distributing_opensource][/doclink]. …
Valve has partnered with Perfect World to bring an onshore version of Steam to China, called Steam China (蒸汽平台). At this time, we are working with a select group of partners for releasing games on Steam China. A prerequisite to publishing games on Steam China is receiving Chinese government approval for your game. Upon receiving approval, the Chinese publisher of your title will be issued an ISBN number, which will be displayed on your Steam China product page. …
[section]Overview[/section] The Steam Families feature allows Steam users to play games from up to five close family members libraries. For more information about the feature, please see our [url=https://store.steampowered.com/news/app/593110/view/4149575031735702628]announcement blog post[/url]. …
If you are having problems solving any Steam Family sharing related issues using these APIs, please contact Steam Support. …
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. …
However, under no circumstances is it okay to charge other developers to participate in a bundle or to sell access to a sale page or other page on Steam. [*][subsection]Paid Advertising Outside Steam[/subsection] Developers may want to run paid advertising campaigns to drive traffic to their Steam product pages. …
[section]Overview[/section] Steam supports persistent leaderboards with automatically ordered entries. These leaderboards can be used to display global and friend leaderboards in your game and on your community webpage. …
[/list] [subsection]Creating via the API[/subsection] Leaderboards for your game can be created through the [url=https://partner.steamgames.com/apps]Steamworks App Admin[/url] or programmatically by calling [api]ISteamUserStats::FindOrCreateLeaderboard[/api]. In Steam, all leaderboards for a Steamworks title are identified by a unique name. The leaderboard name is only used for identification in the Steamworks API, and is not presented to users through the Steam Community. …
"[code-inline]steam_0[/code-inline]", "[code-inline]steam_1[/code-inline]", etc. You can also upload custom icons for your product on the Steamworks site. 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. …
Valve ships hardware to help Steam users get the most out of their Steam Library. The Steam hardware lineup includes Steam Deck, Steam Controller, and the upcoming Steam Machine and Steam Frame devices. All of these devices are powered by Steam, and are optimized for gaming. You can learn about optimizing your titles for these devices by visiting the links below. [list] [*][doclink=steamhardware/steamdeck][/doclink] [*][doclink=steamhardware/steammachine][/doclink] [*][doclink=steamhardware/steamframe][/doclink] [*][doclink=steamhardware/recommendations][/doclink] [*][doclink=steamhardware/loadgames][/doclink] [*][doclink=steamhardware/debugging][/doclink] [*][doclink=steamhardware/proton][/doclink] [*][doclink=steamhardware/compat][/doclink] [/list] [docimg=steamHardware.png]steamHardware.png[/docimg]…