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
No edit summary
 
(42 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{otherlang2
{{LanguageBar}}
| ru = Source SDK Base:ru
{{TabsBar|main=Source SDK Base}}
}} __NOTOC__
__NOTOC__


'''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 unuseable.
{{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.
 
== 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).


== Versions ==
== 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}}.


There are currently four versions of SDK Base: the original [[Episode One (engine branch)|Source 2006]] version (AppID 215), the [[Source 2007]] version ''(AppID 218)'', and two [[Source_SDK_2013|Source 2013]] versions - SP ''(AppID 243730)'' and MP ''(AppID 243750)''.
{{as|4}} deserves mention here too, as it is also freely available and also provides source code.


[[Alien Swarm]] deserves mention here too, as it is also freely available and also provides source code. {{todo|Make a page explaining which game to pick.}}
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.


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


* 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 available. If you want to use episodic things, you will need to [[Gameinfo.txt#Mounting content|mount the appropriate game]].
== Setting up Source SDK and Source SDK Base ==
* 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!}}
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)


== Bugs ==
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


Currently multi-player mods using SDK Base 2006 or 2007 come up with empty server lists in the Steam server browser, while the in-game server browser works. This bug is around since at least the 9th of June, 2013.
=== Source SDK Base 2013 SP / MP (TF2 branch) ===
For {{src13|4}} version of SDK Base, see [[Source SDK Base 2013]] page.


* http://forums.steampowered.com/forums/showthread.php?t=3135128
== Content ==
* http://steamcommunity.com/groups/fof/discussions/0/846955554726069711/
* 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]].
* http://forums.fortress-forever.com/showthread.php?t=24170
* 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!}}


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


<ol>
<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>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>
<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:
<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:
Line 49: Line 59:
</li>
</li>
</ol>
</ol>
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'''.
See [[Fixing VPK mounting for older Source SDK Bases]] in order to fix it.


== Content (2007) ==
== 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


* Source SDK Base 2007 (<code>sourcetest</code>)
{{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).}}
* Source SDK Base + [[Half-Life 2: Lost Coast]] (<code>sourcetest</code>)
* Source 2007 shared (<code>hl2</code>)
* Source shared (<code>hl2</code>)
* [[Source 2007]] engine branch


== Content (2006) ==
== Content (2006) ==
 
* Source SDK Base 2006
* Source SDK Base + [[Half-Life 2: Lost Coast]] (<code>sourcetest</code>)
* Source Engine Test (stripped down version of {{hl2lc|1}}) (<code>sourcetest</code>)
* Source shared (<code>hl2</code>)
* Source Engine Test assets files ({{code|vpks}} - depot 215)
* [[Episode One (engine branch)|Episode One]] engine branch
* 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)