This article's documentation is for anything that uses the Source engine. Click here for more information.

SDK Installation

From Valve Developer Community
Jump to navigation Jump to search
English (en)Deutsch (de)Español (es)Français (fr)Hrvatski (hr)Italiano (it)한국어 (ko)Polski (pl)Português do Brasil (pt-br)Русский (ru)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)Translate (Translate)

The Source SDK is freely available to all Steam users. It is used to develop mods and content for the Source 2006, Source 2007 and Source 2013 engine branches.

Valve games since 2008 onward started to have their own SDK or Authoring Tools, and are engine versions that have no source code available to the public (except Alien Swarm):

Some Third-party games also have their own SDK or Authoring Tools (they may or may not have the source code available to the public):

Note.pngNote:Most of the Source SDK tools, such as Hammer, HLMV, etc... are exclusive to Windows only, but you can run them on Mac/Linux using Wine/Proton.

SteamPipe migration

Valve in 2013 changed how authoring tools were distributed for Team Fortress 2, Counter-Strike Source, Day of Defeat: Source, and Half-Life 2, Half-Life 2: Deathmatch, Portal, as well as other Source 2013 Source 2013 games.

Previously these tools were distributed together under the "Source SDK" tool, which resided in a different folder than the games, had a SDK Launcher, and only supports Source 2009 Source 2009 and earlier. Valve have moved towards a model more similar to L4D, Alien Swarm, Portal 2 and CS:GO, with the exception of the SDK Launcher itself. The SDK tools or Authoring Tools are now shipped with the game by default. Note that the tools are only available for Windows.

Note.pngNote:Check if the tools are downloaded on mac, or if they just don't work

The tools are located in the respective bin folder for the game (e.g: [steam]/steamapps/common/Team Fortress 2/bin) and are meant to be launched from the following batch or exe files:

Note.pngNote:If the tools do not launch, check the environment variables on your computer and change VProject to the directory where gameinfo.txt resides
Also remember to not launch the .exe directly. Launch the .bat instead! The .bat file will detect where the game was installed, and set the VProject variable before launching the tools.

Downloading the source code and launcher

Note.pngNote:For most users, we recommend using the latest available branch, such as Source SDK 2013. Alternatively, Alien Swarm branch can be also used, which have features from Left 4 Dead engine branch and above, however it is not cross-platform compatible by default.

The following instructions are appropriate if you need to download the source code. If you only need the authoring tools, then the instructions probably do not apply to you.

Source 2013

See: Source SDK 2013.

Alien Swarm

See: Alien Swarm - SDK Alien Swarm - SDK

Legacy branches - Source 2006 - 2009/MP

To install Source SDK tools for Source 2006, 2007, 2009 and MP branches, Click here to install the Source SDK.

Screenshot of the now-deprecated "Source SDK" launcher.

For future reference, or if that doesn't work:

  1. Open the Steam window.
  2. Go to the Library.
  3. Change the list to Tools.
  4. Find and double-click on the Source SDK item. You can also use the search bar to find the SDK.
  5. Read over the dialog box and make sure you have enough space, then click Download and Install / Next to continue
  6. The Source SDK will then be downloaded to your computer via Steam.

Source SDK Base

To install Source SDK Base (2006 and 2007), click the following links below:

Source code

  • Source code for the Orange Box (Source 2007) branch is available here on GitHub, or can be obtained in src_mod folder inside 🖿SourceSDK\vpks\depot_211_dir.vpk after installing Source SDK.
  • Source code for the Episode One (Source 2006) branch is available here on GitHub, or can be obtained in src_mod folder inside 🖿SourceSDK\vpks\depot_211_dir.vpk after installing Source SDK.

Source 2004

  • The Source SDK 2004 is no longer officially available. An archive of SDK 2004 is available here on GitHub.

Use

Once Steam has finished downloading you can launch the SDK from the Tools tab. You can also create a desktop shortcut by right-clicking on the SDK in the Tools tab and clicking Create desktop shortcut from the context menu that appears. (Recommended for quick access)

When you first run the SDK it will spend a long time extracting its downloaded archive onto your disk. This will not happen again until the SDK is next updated.

After that, you will be able to select a game and run any of the tools provided by the launcher. However, you will run into problems unless the game you want to work with is fully up to date. You can make sure it is up to date by launching the game and quitting once you get to the main menu, or you can try to verify game files on Steam.

Where do I go from here?

If you want to learn about how to create content for the Source Engine in general, the main page of the Source SDK documentation is a good place to start.

Bugs and Issues

See also