This article's documentation is for anything that uses the Source engine. Click here for more information.
This article relates to the software/tool "Source SDK". Click here for more information.

Source SDK Base: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
 
(73 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{LanguageBar}}
{{TabsBar|main=Source SDK Base}}
__NOTOC__
__NOTOC__
<div align="center">
{| style="background-color: black; width: 80%; margin: .5em 0px; padding: .01em 1em; border: none;"
| style="width: 64px; height: 32px; background-color: black;" | [[Image:steam_available.png]]
| style="text-align: center; background-color: black; color: white;" | This application is available for download.<br />Enter '''steam://run/215''' in your address bar to start it.<br />You can also enter '''steam://store/220''' to purchase <span style="background:yellow">[[Half-Life 2]]</span> and the '''Source SDK Base'''.
|}
</div>


==Purpose==
{{srcsdk|link=Source_SDK_Base}} '''Source SDK Base''' is a game/tool available to all Steam users which is locked to a particular [[:Category:Engine branches|engine branch]]. Compared to basing your mod on a "real" game, use of SDK Base massively increases your potential audience and prevents incompatible engine updates from making your code or the mod unusable.
[[Image:Background010000.jpg|thumb|200px|Source SDK Base|right]]
Valve created ''Source SDK Base'' as a game shared between all owners of their Source titles, from which modders can access stock content and code for their projects. Games that provide access to SDK Base [http://steamgames.com/v/index.php?area=find&category2=16 are listed in the Steam store].


The version of SDK Base this article represents is "legacy". It has been superseded by [[Source SDK Base - Orange Box]] (AppId 218), which was created due to a break in Source's backward compatibility. Mods will not encounter any particular problems if they use this version, but it is recommended that SDK Base - Orange Box and the Orange Box source code be used or be switched to to keep the project current. For new projects, the correct version of SDK Base will be decided automatically by the Mod Wizard.
== Source Engine Test ({{code|sourcetest}}) ==
All Source SDK Bases comes with '''Source Engine Test''', which contains the stripped down version of {{hl2lc|1}} for benchmark purposes ('''Video Stress Test'''), reduced to only the preprogrammed camera following a path that leads the viewer up the mountain. After the sequence completes, the user is presented with a dialogue showing their system performance & framerate and an option to upload them to Valve (which requires {{code|sv_cheats}} to be enabled, and likely no longer works since the old Steam servers used to upload benchmark result has been shutdown).


{{note|The free copies of Source games available through the current nVidia or ATi graphics card promotions ''do not'' provide access to SDK Base.}}
== Versions ==
There are currently four versions of SDK Base: the original [[Source 2006]] version (AppID 215), the [[Source 2007]] version, also known as Orange Box version ''(AppID 218)'', and two [[Source SDK 2013|Source 2013]] versions - SP ''(AppID 243730)'' and MP ''(AppID 243750)''. The MP version (as of 2025) is currently based on {{tf2branch|1}}, but previously used to be {{src13mp|1}}.


==Video Stress Test==
{{as|4}} deserves mention here too, as it is also freely available and also provides source code.
Source SDK Base contains the same video stress test included in [[Half-Life 2: Lost Coast]].


==FAQ==
In most cases, it is recommended to base your game on '''Source SDK Base 2013''', as it's more up to date than previous branch. Source SDK Base 2013 has two sub-branches, with the multiplayer branch (now {{tf2branch|1}}) having some additional features such as [[BSPZIP#Compression|BSP compression]], [[$lightmap|static prop lightmaps]], [[Lightmaps|bicubic lightmaps]], [[env_fog_controller|radial fog]], and [[Team Fortress 2 engine branch|more major changes]]. Meanwhile, the '''{{asbranch|1}}''' add some new engine features (including features first introduced in ''Left 4 Dead'') which were not present in {{src13|1}}, but they can be backported to SDK 2013 (or earlier). Additionally, Alien Swarm branch lacks Linux support.
=== Where can I find Source SDK Base? ===


''Source SDK Base'' can be found on the '''Tools''' tab of the Steam client. You must install '''Source SDK Base''' before you can run a mod based on it. Note that it will only appear here if you have purchased a Source game such as ''Half-Life 2'', ''Half-Life 2: Deathmatch'', ''Counter-Strike: Source'', etc.
Older version of SDK Base (2006, 2007) are provided in order to play older mods.


=== Do I have to base my mod on Source SDK Base? ===
== Setting up Source SDK and Source SDK Base ==
Install Source SDK Base 2006/2007 from Steam->Library->Tools or from the links below:
* [steam://rungameid/215 Install/Run Source SDK Base 2006] (AppID: 215)
* [steam://rungameid/218 Install/Run Source SDK Base 2007] (AppID: 218)


No. The Source engine still supports the notion of basing mods on particular games and that will not change.
To get the SDK source code, download Source SDK:
* [steam://rungameid/211 Install/Run Source SDK] (AppID: 211)
* After installing Source SDK, go to {{path|...\Steam\steamapps\common\SourceSDK\vpks}}, open {{code|depot_211_dir.vpk}} (using {{vpkedit|1}} or {{gcfscape|1}}), go to {{code|src_mod}} folder, there will be two folders:
** {{code|ep1}} - contains {{src06|1}} gamecode
** {{code|orangebox}} - contains {{src07|1}} gamecode


=== Why would I want to base my mod on Source SDK Base? ===
=== Source SDK Base 2013 SP / MP (TF2 branch) ===
For {{src13|4}} version of SDK Base, see [[Source SDK Base 2013]] page.


If you want to make a [[Half-Life 2]] single-player mod and want to take advantage of the newest Source engine then you should definitely base your mod on ''Source SDK Base''. Another reason you might want to do is that ''Source SDK Base'' is more lightweight than other applications (i.e. fewer unwanted assets are loaded).
== Content ==
* The stock gamecode is a duplicate of [[Episode One]]'s or [[Episode Two]]'s, depending on which version (see below) you are using. '''But the only ''content'' available is that of [[Half-Life 2]] and [[Half-Life 2: Lost Coast]]''': while [[npc_zombine|Zombines]] and [[npc_hunter|Hunters]] exist in the code and can be spawned, they appear as errors because their [[model]]s are not included. If you want to use episodic things, you will need to [[Gameinfo.txt#Mounting content|mount the appropriate game]].
* SDK Base might provide mods with Lost Coast's content, '''but [[dedicated server]]s do not'''. Multiplayer mods should either not use anything from ''Lost Coast,'' or include what they do use in their dedicated server download. {{tip|In Source 2007 or later you can remove the <code>sourcetest</code> SearchPath from gameinfo.txt and Lost Coast will disappear. Unfortunately, doing this under Source 2006 (Episode One) will make the game crash immediately!}}


=== Does Source SDK Base work with multi-player mods as well? ===
== Bugs and Fixes ==
There are two small glitches and things that need to be changed:


Yes. But since Valve's multi-player games have been updated to utilize the latest Source engine we find that most multi-player mods are based on [[Half-Life 2: Deathmatch]] (SteamAppId 320).
<ol>
<li>The main menu has a "Visual Stress Test" option instead of anything useful. Copy <code>resource\[[GameMenu]].res</code> from another suitable game into your mod.
</li>
<li>Episode Two's flashlight and weapon pickup icons do not appear. Open <code>resource\ClientScheme.res</code> and add this to the <code>Fonts</code> section:


=== How do I mount additional content for my mod? ===
<source lang=php>
WeaponIconsSmall
{
1
{
name HalfLife2
tall 32
weight 0
antialias 1
additive 1
custom 1
}
}
</source>
</li>
</ol>


See [[IFileSystem#Mount_Steam_Application_Content|this article on the Steam File System]].
In addition, '''Source SDK Base 2007''' is unable to mount {{hl2ep2|1.bold}} content from provided depot VPKs, because of a missing config file and the VPKs being switched around with '''Base 2006'''.


=== I have a copy of Half-Life 2: Deathmatch that came free with my ATI or nVidia video card. Why can't I install Source SDK Base? ===
See [[Fixing VPK mounting for older Source SDK Bases]] in order to fix it.


The free version of ''Half-Life 2: Deathmatch'' does not unlock ''Source SDK Base''. You will need to purchase one of Valve's other Source-based games in order to get it.
== Content (2007) ==
* Source SDK Base 2007
* Source Engine Test (stripped down version of {{hl2lc|1}}) (<code>sourcetest</code>)
* Source Engine Test assets files ({{code|vpks}} - depot 215)
* Base Source shared / {{hl2|1}} assets (<code>hl2</code>)
* Base Source shared / {{hl2|1}} assets ({{code|vpks}} - depot 206, 207, 208)
* {{hl2ep1|1}} assets ({{code|vpks}} - depot 213, 381)
* {{hl2ep2|1}} assets ({{code|vpks}} - depot 421, 422, 423)
** {{Note|EP2 assets is missing by default, due to being switched around with Base 2006.}}
* [[Source 2007]] engine branch


==Wish List Items==
{{Note|Source SDK Base 2007 depot also includes "Source 2007 Binaries 2" (depot 317), which is actually Source 2009 binaries. These can be only obtained through Steam developer console (using {{code|download_depot 218 317}} command).}}
* Include zoo maps containing many of the models available in ''Source SDK Base''.
 
== Content (2006) ==
* Source SDK Base 2006
* Source Engine Test (stripped down version of {{hl2lc|1}}) (<code>sourcetest</code>)
* Source Engine Test assets files ({{code|vpks}} - depot 215)
* Base Source shared / {{hl2|1}} assets (<code>hl2</code>)
* Base Source shared / {{hl2|1}} assets ({{code|vpks}} - depot 206, 207, 208)
* {{hl2ep1|1}} assets ({{code|vpks}} - depot 213, 381)
* [[Source 2006]] engine branch


[[Category:Tools]]
[[Category:Tools]]
{{Source topicon}}{{Srcsdk topicon}}
[[Category:Source 2006]]
[[Category:Source 2007]]

Latest revision as of 06:02, 3 August 2025

English (en)한국어 (ko)Русский (ru)Translate (Translate)
edit


Source SDK Source SDK Base is a game/tool available to all Steam users which is locked to a particular engine branch. Compared to basing your mod on a "real" game, use of SDK Base massively increases your potential audience and prevents incompatible engine updates from making your code or the mod unusable.

Source Engine Test (sourcetest)

All Source SDK Bases comes with Source Engine Test, which contains the stripped down version of Half-Life 2: Lost Coast for benchmark purposes (Video Stress Test), reduced to only the preprogrammed camera following a path that leads the viewer up the mountain. After the sequence completes, the user is presented with a dialogue showing their system performance & framerate and an option to upload them to Valve (which requires sv_cheats to be enabled, and likely no longer works since the old Steam servers used to upload benchmark result has been shutdown).

Versions

There are currently four versions of SDK Base: the original Source 2006 version (AppID 215), the Source 2007 version, also known as Orange Box version (AppID 218), and two Source 2013 versions - SP (AppID 243730) and MP (AppID 243750). The MP version (as of 2025) is currently based on Team Fortress 2 branch, but previously used to be Source 2013 Multiplayer.

Alien Swarm Alien Swarm deserves mention here too, as it is also freely available and also provides source code.

In most cases, it is recommended to base your game on Source SDK Base 2013, as it's more up to date than previous branch. Source SDK Base 2013 has two sub-branches, with the multiplayer branch (now Team Fortress 2 branch) having some additional features such as BSP compression, static prop lightmaps, bicubic lightmaps, radial fog, and more major changes. Meanwhile, the Alien Swarm engine branch add some new engine features (including features first introduced in Left 4 Dead) which were not present in Source 2013, but they can be backported to SDK 2013 (or earlier). Additionally, Alien Swarm branch lacks Linux support.

Older version of SDK Base (2006, 2007) are provided in order to play older mods.

Setting up Source SDK and Source SDK Base

Install Source SDK Base 2006/2007 from Steam->Library->Tools or from the links below:

To get the SDK source code, download Source SDK:

Source SDK Base 2013 SP / MP (TF2 branch)

For Source 2013 Source 2013 version of SDK Base, see Source SDK Base 2013 page.

Content

  • The stock gamecode is a duplicate of Episode One's or Episode Two's, depending on which version (see below) you are using. But the only content available is that of Half-Life 2 and Half-Life 2: Lost Coast: while Zombines and Hunters exist in the code and can be spawned, they appear as errors because their models are not included. If you want to use episodic things, you will need to mount the appropriate game.
  • SDK Base might provide mods with Lost Coast's content, but dedicated servers do not. Multiplayer mods should either not use anything from Lost Coast, or include what they do use in their dedicated server download.
    Tip.pngTip:In Source 2007 or later you can remove the sourcetest SearchPath from gameinfo.txt and Lost Coast will disappear. Unfortunately, doing this under Source 2006 (Episode One) will make the game crash immediately!

Bugs and Fixes

There are two small glitches and things that need to be changed:

  1. The main menu has a "Visual Stress Test" option instead of anything useful. Copy resource\GameMenu.res from another suitable game into your mod.
  2. Episode Two's flashlight and weapon pickup icons do not appear. Open resource\ClientScheme.res and add this to the Fonts section:
    		WeaponIconsSmall
    		{
    			1
    			{
    				name		HalfLife2
    				tall		32
    				weight	0
    				antialias 1
    				additive	1
    				custom	1
    			}
    		}
    

In addition, Source SDK Base 2007 is unable to mount Half-Life 2: Episode Two content from provided depot VPKs, because of a missing config file and the VPKs being switched around with Base 2006.

See Fixing VPK mounting for older Source SDK Bases in order to fix it.

Content (2007)

Note.pngNote:Source SDK Base 2007 depot also includes "Source 2007 Binaries 2" (depot 317), which is actually Source 2009 binaries. These can be only obtained through Steam developer console (using download_depot 218 317 command).

Content (2006)