Below is a guide to using SteamPipe, Valve's tool for delivering content to Steam. For more information on best practices for updating your game, see Updating Your Game - Best Practices
Introduction to the SteamPipe Content System
SteamPipe is the game/application content system that powers Steam. SteamPipe includes the following features:
- Efficient and fast content delivery.
- Các nhánh "beta" công khai và riêng tư cho phép thử nghiệm nhiều bản build.
- Simple web-based management of builds - push out a new build or rollback to a previous build with just a few clicks.
- Ability to see the update size of a build before setting it live.
- Ability to share content between multiple applications.
- Ability to build installer discs from public or beta content.
- Games/apps stay available offline even after an update download has been started.
- All content is always encrypted, and non-active versions are not visible to customers.
- A SteamPipe Local Content Server which can be used during development.
There are a few concepts which are integral to SteamPipe, before getting started you should be familiar with all of the concepts outlined in the Applications
documentation. Having even a basic understanding of how these pieces fit together will be very useful when uploading your product to Steam.
Game Content Structure - Best Practices
SteamPipe was designed for both efficient downloading of initial game installs and efficient patching of updates. In general, it works well for a wide variety of game content structures. However, there are some important things to know in terms of optimization and avoiding situations that can cause inefficiency.
SteamPipe initially splits each file into roughly one megabyte (MB) chunks. Each chunk is then compressed and encrypted before being upload to the Steam content-delivery system. They remain compressed and encrypted until downloaded by each client, where they are decrypted and expanded and placed in the necessary file location(s).
When SteamPipe is processing an update for an existing game, it searches to find any such chunks that match the previous build of the game. This way, ideally only the new or modified portions of any file are turned into "new" chunks, and those new chunks are the only pieces a client must download to update their game.
Many game engines use "pack" files to coalesce game assets, and improve load times by allowing more efficient disk access. In general, this works well with SteamPipe. However, some pack file systems use or enable using behaviors that can cause problems. The effect of these problems is almost always that updates are much larger than necessary. They can also result in a quick download but a slow update process as large amounts of local disk IO are necessary.
If your game uses pack files, here are some general guidelines.
- Ensure asset changes are localized within the pack file as much as possible
- Avoid shuffling asset ordering with a pack file
- limit pack file size
- group assets by level / realm / feature into their own pack files, and consider adding new pack files for updates instead of modifying existing ones
- do not include any original filenames or file / build timestamps for each asset
The first point above refers to the scope of what bytes are changed within a file when a single asset is modified. If that asset's data is modified and/or grows or shrinks within the same location of the pack file, that is ideal. SteamPipe will only create new chunks for the portions of the file containing the asset data. However, all pack files need some sort of Table of Contents (TOC) as well so that the engine can locate the asset data. The structure of this TOC can have a large impact on the efficiency of SteamPipe patching. Ideally, there is one TOC or TOC tree near the beginning or end of the file. Because other assets may shift byte position within the file, their TOC entries will change as well. In this situation, SteamPipe will make new chunks for the modified asset data and the modified portions of the TOC.
However, what we have seen in some game engines is that the TOC information is distributed throughout the file. 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. This can have catastrophic effects where even changing a few small assets in a pack file results in clients needing to download over half the entire file to update. If you know or suspect that your pack file structure is causing this issue, please contact your Valve representative as soon as possible. We have an alternate build algorithm that can help mitigate this issue, though it has tradeoffs.
Additionally, SteamPipe does not know about asset boundaries within a pack file. If sub-megabyte assets are shuffled, it will most likely not be able to detect this reordering as the previously determined 1-MB chunks will no longer be present within the file. So if, in the process of creating an update for your game, you wish to optimize load times by reordering assets within the pack file, be cognizant of the fact that it may result in a very large download for that update. We recommend only doing this if the performance improvements are significant.
Next - to update the pack file on a client device, SteamPipe builds the new version alongside the old version. When all new files are built, it then "commits" the update by deleting old files and moving the new files in. What this means is that to update a 25 GB pack file, SteamPipe will always build a new, 25GB file. If the update only requires 10 bytes of changes to that file, SteamPipe will need to copy almost the entire 25GB from the old file to the new file. Depending on the client storage hardware, this can be a very slow process. For this reason, we recommend two things.
First - limit the size of pack files. Probably one or two gigabytes (GB) is sufficiently large - more than enough to allow efficient disk reads when loading the game.
Second - keep the scope of assets within a single pack file fairly limited. Perhaps to a single game level, or unlockable feature. This way, updates that are focused on specific parts of your game don't cause the data from other parts to be copied around on the client machine. Additionally, when adding new functionality / levels / etc, these can and likely should be placed in their own new pack files. Clients downloading this update will have a simple download of new files, avoiding any of the issues mentioned above with pack file modifications.
When in doubt, you can use a local binary diff tool such as Beyond Compare to compare versions of your pack files. Verify that the differences shown are of the size you expect for the changed assets, and that there aren't perhaps dozens or hundreds of small changes spread out throughout the file. If what you see is unexpected, check your pack file tool settings. Compression
: Because Steam will compress all data for upload / storage / download, we generally don't recommend using general compression on pack files. However, if you are concerned about the on-disk size of your game, you may still want to use pack file compression. It will work OK with SteamPipe so long as the criteria listed above are met. Specifically, you should ensure that compression is per-asset as much as possible. Any compression that crosses asset boundaries will spread out changes and require clients to download more data than necessary.Encryption
: This is similar to compression - most likely unnecessary, and with the same risks mentioned above.
If you follow these rules you will minimize patch sizes and only new content will need to be downloaded. Your customers will thank you for that and you will be able to increase the quality of your product by shipping more updates.
If you suspect that your game packaging is not interacting well with the SteamPipe update process, please contact your Valve representative and we can look into enabling advanced features to help with this.
Steamworks Video Tutorial - Building Your Game in Steampipe
This tutorial introduces SteamPipe and steps through building a sample application for Steam via the Steamworks tools.https://www.youtube.com/watch?v=SoNH-v6aU9Q
Steamworks Video Tutorial - Adding New Platforms and Languages
This tutorial walks you through adding new platforms and languages to your game by adding depots to your app.https://www.youtube.com/watch?v=PShS32hcing
SteamPipe Technical Details
SteamPipe uses the HTTP protocol for content delivery. Since downloads are regular web traffic, any third-party HTTP cache between the customer and Steam servers will increase download speed. Content can be hosted by external CDN providers, which can be easily added to our content network. Most consumer firewalls allow HTTP traffic and won't block downloads.
SteamPipe has an efficient patching algorithm based on binary deltas, only changing the modified portions of existing content files. When this content is updated, only these deltas need be sent. This means both developer and user transfers are smaller and faster. Most partners will find that using a SteamPipe Local Content Server
not necessary since they can efficiently patch builds on private branches.
Steam Build Account
Before you can create any builds on Steam, you must have a Steam account in your Steamworks account with the "Edit App Metadata" and "Publish App Changes To Steam" permissions granted. For security reasons it's recommended that you have a dedicated build account with just those permissions, you may create a new Steam account for this purpose at https://store.steampowered.com/join
Any administrator of your Steamworks account can add a Steam account and grant the necessary permissions. More information on this process can be found in the Quản lý tài khoản Steamworks của bạn
documentation. An example of what this account might look like is:
Initial Setup for New SteamPipe Apps
Follow these steps to set up new SteamPipe apps:
- Find the app ID for your application (this can be found by selecting the application on your homepage in Steamworks)
- Go to the General Installation Settings page for your app.
- Define at least one launch option (the path and optionally, any arguments required to launch the game). Hover over the (?) to learn more about each field.
The example below shows 5 launch options, 2 for Windows, 2 for macOS and 1 for Linux.
Launch option 3 will only be shown on Windows if the user also owns the DLC specified.
- Go to the Depots page and add depots as needed for this app. By default, a depot may already be configured for your application.
- Click the default depot and change the name of the depot to a proper and recognizable name (such as "Base Content" or "Windows Content").
- Leave the language set to [All languages] unless this is a language-specific depot.
- Leave the OS set to [All OSes] unless this is an OS-specific depot (if the app is all-in-one, or is just PC or just Mac, it should be left to [All OSes]. Only specify for OS-specific game depots.
- Click Add New Depot to create additional depots.
- Click Save Changes to save any changes made.
- Once you are done defining your depots, publish the changes that you have made from the Publish page.
- Your newly defined depots will need to be included in a package to grant you ownership of them. Each game on Steam should have a Developer Comp package which is automatically granted to the accounts listed within your publisher group.
You can add the new depots to that package (and/or other packages that should have these depots) on the Associated Packages & DLC page.
Note: If your executable is in a sub-folder of the main installation folder, add the sub-folder name in the Executable field. Don't use leading slashes or dots.
Platform Note: As shown above, macOS applications may be launched by specifying either an app bundle (Game.app) or a script/binary (Game.app/Contents/MacOS/Game). In general the app bundle format should be preferred if possible as it allows macOS to more correctly determine launch parameters in the manner it would if launched manually outside of Steam.
One instance of this to note is that currently applications that are launched through an app bundle on Apple Silicon devices will launch the best architecture available in the application whereas direct binary launches will use the same architecture as the Steam process (currently x86_64).
Setting up the SDK for SteamPipe uploads
Download and unzip the latest version of the Steamworks SDK on the machine you will be uploading builds on.
The SteamPipe tools can be found within the SDK in the
folder which contains 2 relevant sub-directories.
directory is where your game content and SteamPipe build tools will live. This directory contains the following sub-directories:
- builder - This directory initially contains just steamcmd.exe which is the command line version of Steam.
- builder_linux - The linux version of steamcmd.
- builder_osx - The macOS version of steamcmd.
- content - This directory contains all game files that will be built into depots.
- output - This directory will be the location for build logs, chunk cache, and intermediate output. NOTE: This folder can be deleted or emptied at any time, but after it's deleted, the next upload time will take longer.
- scripts - This directory is where you'll place all of your build scripts for building your game depots.
It's recommended that you run steamcmd.exe directly in the builder folder for your platform once to bootstrap your build system. This should populate your builder directory with all the files it needs to build depots.
directory contains the tools for running your own SteamPipe Local Content Server
if you choose to do so.
SteamCmd on macOS
To enable SteamCmd on macOS you must complete the following steps:
- 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
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.
Creating SteamPipe Build Config Files
To upload files for your app with SteamPipe, you must create scripts which describe your build and each depot that will be included in it. The example scripts shown here are in the
folder in the Steamworks SDK.
SteamPipe GUI Tool
If you're running on Windows and would prefer a GUI tool to help create these config files and upload your builds you can use the SteamPipeGUI which is available in the tools folder of the Steamworks SDK. Included in the zip are additional instructions to get you started.
If you choose to use the GUI tool then reading the following sections is still recommended to help you become more familiar with how the SteamPipe system works.
Simple Build Script
Let's start with the most basic build script possible. In our example we have a game (AppID 1000) that has one depot (DepotID 1001) and want to upload all files from a content folder and it's subfolders. We just need a single build script for that, take a look at
included in the SDK :
"AppID" "1000" // your AppID
"Desc" "This is a simple build script" // internal description for this build
"ContentRoot" "..\content\" // root content folder, relative to location of this file
"BuildOutput" "..\output\" // build output folder for build logs and build cache files
"1001" // your DepotID
"LocalPath" "*" // all files from contentroot folder
"DepotPath" "." // mapped into the root of the depot
"recursive" "1" // include all subfolders
Adjust the AppID and DepotID for your game as needed. To kick off a build you need to run steamcmd and pass a couple of parameters :
tools\ContentBuilder\builder\steamcmd.exe +login <account_name> <password> +run_app_build ..\scripts\simple_app_build.vdf +quit
Your first attempt at running a build may fail due to Steam Guard. If the login fails due to Steam Guard, check your email for the Steam Guard code, and run steamcmd as:
steamcmd.exe "set_steam_guard_code <code>"
, and try again. After logging in with Steam Guard once, a sentry file is used to verify the login is genuine.
If you are using steamcmd from a machine or VM that gets re-imaged frequently, you should include the config file in your image so you won't be prompted for a Steam Guard every time. The the config file is located in <Steam>\config\config.vdf.
The following steps occur during a SteamPipe build:
- Steamcmd.exe will update itself to the latest version.
- Steamcmd.exe is logging into the Steam backend using the given builder Steam account.
- The app build start is registered with the MDS (Master Depot Server), which will ensure the user has the proper privileges to modify this app.
- For each depot included in the app build, a file list is generated based on the files in the content folder and the filter rules defined in depot build config file.
- Each file is scanned and divided into small chunks of about 1MB. If the depot has been built before, this partitioning will preserve as many of the unchanged chunks as possible.
- New file chunks are compressed, encrypted, and then uploaded to the MDS.
- A final manifest is generated for this depot version; each manifest is identified by a unique 64-bit manifest ID.
- Once all depots have been processed, the MDS finishes this app build and assigns it a global BuildID.
- After the build is done, there may be *.csm and *.csd files in the build ouput folder. These are temporary and can be deleted, but they speed up subsequent build times.
Once the build is complete you can see it on your app builds page, in this case it would be https://partner.steamgames.com/apps/builds/1000
. There you can set that build live for the default branch or any beta branch and users will be able to download this update with a couple of minutes.
Advanced Build Scripts
If your app has a lot of depots with complex file mapping rules, you can create a depot build script for each depot which will be referenced by the app build script. First let's take a look at available parameters in the app build script:
AppID - The AppID of your game. The uploading Steam partner account needs 'Edit App Metadata' privileges
Desc - The description is only visible to you in the 'Your Builds' section of the App Admin panel. This can be changed at any time after uploading a build on the 'Your Builds' page.
ContentRoot - The root folder of your game files, can be an absolute path or relative to the build script file.
BuildOutput - This directory will be the location for build logs, depot manifests, chunk caches, and intermediate output. For best performance, use a separate disk for your build output. This splits the disk IO workload, letting your content root disk handle the read requests and your output disk handle the write requests.
Preview - This type of build only outputs logs and a file manifest into the build output folder. Building preview builds is a good way to iterate on your upload scripts and make sure your file mappings, filters and properties work as intended.
Local - Set this to the htdocs path of your SteamPipe Local Content Server (LCS). LCS builds put content only on your own HTTP server and allow you to test the installation of your game using the Steam client.
SetLive - Beta branch name to automatically set live after successful build, none if empty. Note that the 'default' branch can not be set live automatically. That must be done through the App Admin panel.
Depots - This section contains all file mappings, filters and file properties for each depot or references a separate script file for each depot
Example app build script
is using all options:
"AppID" "1000" // Your AppID
"Desc" "Your build description here" // internal description for this build
"Preview" "1" // make this a preview build only, nothing is uploaded
"Local" "..\..\ContentServer\htdocs" // put content on local content server instead of uploading to Steam
"SetLive" "AlphaTest" // set this build live on a beta branch
"ContentRoot" "..\content\" // content root folder relative to this script file
"BuildOutput" "D:\build_output\" // put build cache and log files on different drive for better performance
// file mapping instructions for each depot are in separate script files
This app build script references two depot build script files that specify all file mappings and file properties. The following instructions are available in a depot build script ( and also if the section is included directly into the app build script).
DepotID - The DepotID for this section
ContentRoot - Lets you optionally override the ContentRoot folder from the app build script on a per depot basis
FileMapping - This maps a single file or a set of files from the local content root into your depot. There can be multiple file mappings that add files to the depot. The
LocalPath parameter is a relative path to the content root folder and may contain wildcards like '?' or '*'. It will also apply to matching files in subfolders if
Recursive is enabled. The
DepotPath parameter specifies where the selected files should appear in the depot (use just '.' for no special mapping)
FileExclusion - will excluded mapped files again and can also contain wildcards like '?' or '*'
InstallScript - will mark a file as install scripts and will sign the file during the build process. The Steam client knows to run them for any application which mounts this depot.
FileProperties - will mark a file with special flags:
userconfig - This file is modified by the user or game. It cannot be overridden by an update, and it won't trigger a verification error if it's different from the previous version of the file.
versionedconfig - Similar to userconfig, however if the file is updated in the depot, it will be overwritten locally when the user's game updates. Only update the file in the depot when there is a necessary format change or bug fix.
Example depot build script
showing use of all options:
"ContentRoot" "C:\content\depot1002" // override ContentRoot from app build script
// all source files and folders in ".\bin" will be mapped into folder ".\executables" in depot
"Recursive" "1" // include all subfolders
// override audio files in \\audio with German versions
// copy install script for german version into depot root folder
"FileExclusion" "bin\server.exe" // exclude this file
"FileExclusion" "*.pdb" // exclude all .PDB files everywhere
"FileExclusion" "bin\tools*" // exclude all files under bin\tools\
"Attributes" "userconfig" // this file will be modified during runtime
You can name these scripts what ever you want, but we use the names
for consistency. If you know that you'll be building apps on this machine, it might be a good idea to create sub-directories in your scripts directory for each application, to help organize each application's build scripts.
After your app releases to customers, your customers will be receiving the build marked as the Default build. When uploading a new build it's always a good idea to test it before shipping it to your customers, for more information on how to successfully do this see Thử nghiệm trên Steam
Debugging Build Issues
If your build wasn't successful, you should look in your output directory for error information, not the console where the build script was run. Most error information can be found in the *.log files.
You can use these Steam client commands and client-side files to debug issues:
"app_status [appid]" - Shows the current state of the app on this client.
"app_info_print [appid]" - Shows the current Steamworks configuration for this game (depots, launch options, etc.).
"app_config_print [appid]" - Shows the current user configuration for this game (current language, install directory, etc.).
file "logs\content_log.txt" - Lists all logged SteamPipe operations and errors.
file "steamapps\appmanifest_[appid].acf" - Shows the current install state of this app (KeyValues).
Building Retail Install Discs
To build retail install disc for SteamPipe games, you must first setup a build project file.
In this example, the SKU file is called "sku_goldmaster.txt":
"name" "Test Game Installer"
Some tips to keep in mind:
Optionally building a retail installer from a beta branch
The process above will create a retail installer based on the default branch. If you need to create an installer based on a beta branch, you must first create a beta branch named "baseline". Then use the following command to build from the baseline branch:
build_installer <project file> <target folder> <beta key> <beta pwd>
steamcmd ex: build_installer sku_goldmaster.txt "D:\retail_disks" baseline superSecret
script ex: steamcmd.exe +login user_name password +build_installer "..\Build\GameDataSku.txt" c:\destination beta_key beta_password +exit
Installing DLC from a retail installer
In some circumstances, you may wish to create a retail installer that includes your DLC packages. In such cases, the process to create the installer requires only a few changes.
In "sku_goldmaster.txt", include the DLC AppIDs under the "included_depots" section. Once you have run the "build_installer" process, find the generated sku.sis file for the installer and open it with a text editor.
Add the DLC AppID in the "apps" section. For example, if I had a game with AppID 1000 and DLC AppID 1010, I would adjust the "apps" section as follows:
This will ensure that Steam checks for ownership of the DLC and prompt the user for a key if the DLC is not owned by the account that they are logging into on Steam.
Building a retail installer for multiple App IDs on a single disc/install package
To build a GM containing multiple Steam Pipe apps. Build each app installer one by one but point them all to the same output folder. Each build will merge itself with the already existing install image.
Customizing a Retail install disk
See Customizing a gold master
for more details on customizing your retail install disk.
Preloading Games before Release
By default, all content is always encrypted, on all retail discs and on all content servers. Switching a game to preload mode means owners can download the content, but it stays encrypted on the users' disk and can't be played. Once the game becomes officially released, Steam will decrypt the preloaded content and the user can play the game.
Switching a game to preload mode is recommended in these cases:
- Shipping retail discs with product keys before the game is actually available (0-day piracy).
- Games that run a pre-purchase and are larger than 20GBs in size.
Please submit a ticket to Steam Publishing if you believe your game requires preloading.
DLC is built as a depot of the base game. See the Downloadable Content (DLC)
documentation for more information.
"Login Failure: Account Login Denied Failed" when logging in via steamcmd
Cause: Probably SteamGuard is preventing login. Resolution:
- Check the email associated with the account you are trying to log on with and look for an email from Steam Support. Copy the code from that email.
- Run the following steamcmd:
- Re-Attempt login from steamcmd:
Steam>login <buildaccount> <password>
General Troubleshooting for Download Issues
- Restart computer, modem, router, etc.
- Verify firewall settings. The new system requires port 80 (HTTP) and all other Steam ports, listed here.
- Temporarily disable local Anti-Virus or Spam-Blocker programs.
- Check the Steam download region under Settings->Downloads. It should match your location.
- Stop the download, uninstall, and reinstall the game (clear manifest caches).
- Exit Steam, delete the two folders appcache and depotcache in your Steam install folder.
- Try to set your Steam download region to some other location far away. This might work if a content server near you is serving bad data.
My Mac and/or Linux Builds aren't installing any files. Why?
If you're testing via Steam the installation of your game or application across multiple platforms, you may run into a situation where the build deploys on Windows but doesn't deploy any files on Mac or Linux despite your SteamPipe process being setup to upload Mac and/or Linux depots. There is a step that is easily missed which involves adding your alternate Depots to the Package being deployed. You can check what depots are included in a package via the following steps:
- Navigate to your App Admin page
- From the View Associated Items section, click All Associated Packages, DLC, Demos and Tools.
- Click on the title of the Package you're attempting to download
- Review the Depots Included section
- Use the Add/Remove Depots to ensure the correct set of Depots are assigned to the Package
There are a number of discussion threads about this that may also assist:
Running steamcmd.exe results in the following error: "SteamUpdater: Error: Steam needs to be online to update. Please confirm your network connection and try again."
Resolution: Go to Internet Options
and check Automatically detect settings
Running the app build results in the following error: "ERROR! Failed 'DepotBuild for scriptname.vdf' - status = 6."
- Account does not have permissions for the app.
- Check that the app ID is correct in the app_build.vdf.
- Check that the build account has proper permissions to the app ID.
- Steamcmd cannot find the depot contents.
- Check that the "contentroot" value in the app_build script is a valid path relative to the location of the script file.
- Check that the "LocalPath" value in the depot_build script is a valid path relative to the path in the app_build script. Check that the path contains actual content.
Running the app build results in the following error: "ERROR! Failed to get application info for app NNNNN (check login and subscription)"
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.
- Check that the NNNNN is the app ID you were assigned for the app.
- Check that the app ID is correct in the app_build.vdf.
- If it is a new app ID, check that the Steamworks app admin configuration has been published. New apps should have a Steam Pipe install directory on the config tab, a depot on the depot tab, and all changes published on the publish tab.
- If all of that looks right, make sure that your account owns the app ID.
"An error occurred while installing [AppName] (Invalid content configuration)" at launch time
"Error code 15" at launch time
This is the CEG servers rejecting the request to CEG the exe. Check the release state on the game page. If it is not 'playable', you will need to request Steam keys that override the release state.
"The Steam Servers are too busy to handle your request... Error Code (2)" at launch time
This is the CEG servers failing to find a matching CEG exe. Double check that you have a working CEG executable on the CEG tab of your app admin. Click the 'status' button to make sure that it's propped.
I can't remember what that steamcmd command was or how it worked
Use the 'find' command in steamcmd to search for any steamcmd command. It will do partial matching on the command name and it will list out the command syntax.
build_installer : <project file> <target folder> <beta key> <beta pwd>