Difference between revisions of "SDK Installation"

From Valve Developer Community
Jump to: navigation, search
m (Changed links to authoring tools to use the Game link template)
 
(18 intermediate revisions by 11 users not shown)
Line 14: Line 14:
 
}} {{toc-right}}
 
}} {{toc-right}}
  
'''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 2009]] engine branches.
+
'''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.
  
More recent Valve games each have their own SDK or Authoring Tools:
+
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:
  
* {{l4d}} [[Left 4 Dead Authoring Tools]]
+
* {{Game link|Left 4 Dead Authoring Tools}}
* {{l4d2}} [[Left 4 Dead 2 Authoring Tools]]
+
* {{Game link|Left 4 Dead 2 Authoring Tools}}
* {{as}} [[Alien Swarm SDK]] (free to all)
+
* {{Game link|Alien Swarm SDK}} (free to all)
* {{portal2}} [[Authoring Tools/SDK (Portal 2)|Portal 2 Authoring Tools]]
+
* {{Game link|Portal 2 Authoring Tools}}
* {{csgo}} [[Authoring_Tools/SDK_(CSGO)|Counter-Strike: Global Offensive Authoring Tools]]
+
* {{Game link|Counter-Strike: Global Offensive Authoring Tools}}
  
("Authoring Tools" means that source code is not provided.)
+
== SteamPipe migration and abandonment of the Source SDK app ==
  
== Authoring tools currently shipped as beta with their respective games ==
+
Valve in 2013 changed how authoring tools were distributed for [[Team Fortress 2]], [[Counter-Strike Source]], [[Day of Defeat: Source]], and
 +
[[Half-Life 2: Deathmatch]].
  
We're in the process of changing how the authoring tools are distributed for the following games:
+
Previously these tools were distributed together under the "Source SDK" tool, which resided in a totally different folder from the games. Valve moved towards a model more similar to L4D and CS:GO.  The SDK tools are currently shipped with the game by default. Note that the tools are only available for Windows.
  
* Team Fortress 2
+
The tools are located in the respective bin folder for the game (e.g: <code>[steam]/steamapps/common/Team Fortress 2/bin</code>) and are meant to be launched from the following batch files:
* Counter-strike: Source
 
* Day of Defeat: Source
 
* Half-Life: Deathmatch
 
 
 
Previously these tools were distributed together in a single package (the "Source SDK" application), which resided in a totally different folder from the games.  We're moving towards a model more similar to L4D and CS:GO.  The authorizing tools are now distributed as a beta of the game.  To opt into this beta, to the following:
 
 
 
# Right click on the game, and select "properties."
 
# Select the "betas" tab.
 
# Select the "sdktools_beta" beta.
 
# Let Steam update the game.
 
 
 
Now look in the bin folder(E.g: [steam]/steamapps/common/Team Fortress 2/bin) You should see several new batch files in the bin folder, which can be used to setup the proper environment and launch the tools:
 
  
 
* hammer.bat
 
* hammer.bat
Line 50: Line 39:
 
* vtex.bat
 
* vtex.bat
  
Use these batch files to launch the tools.  The SDK launcher is no longer used.
+
{{note|If the tools do not launch, check the environment variables on your computer and change VProject to the directory where gameinfo.txt resides}}
  
 
== Installation of source code and launcher  ==
 
== Installation of source code and launcher  ==
  
The following instructions are appropriate if you need to download Source code.  If you only need the authoring tools, you probably do not apply to you.
+
The following instructions are appropriate if you need to download Source code.  If you only need the authoring tools, they probably do not apply to you.
 +
 
 +
=== Source 2013 ===
 +
See: [[Source SDK 2013]].
 +
 
 +
=== Legacy branches ===
  
 
[steam://run/211 Click here to install the Source SDK.] For future reference, or if that doesn't work:
 
[steam://run/211 Click here to install the Source SDK.] For future reference, or if that doesn't work:

Latest revision as of 21:04, 30 August 2019

Čeština Deutsch Español Français Italiano Русский Türkçe 简体中文 简体中文 한국어 ქართული ენა

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:

SteamPipe migration and abandonment of the Source SDK app

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

Previously these tools were distributed together under the "Source SDK" tool, which resided in a totally different folder from the games. Valve moved towards a model more similar to L4D and CS:GO. The SDK tools are currently shipped with the game by default. Note that the tools are only available for Windows.

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 files:

  • hammer.bat
  • faceposer.bat
  • hlmv.bat
  • stdudiomdl.bat
  • vtex.bat
Note:If the tools do not launch, check the environment variables on your computer and change VProject to the directory where gameinfo.txt resides

Installation of source code and launcher

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

Source 2013

See: Source SDK 2013.

Legacy branches

Click here to install the Source SDK. 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.
  5. Read over the dialog box and click Download and Install / Next to continue
  6. The Source SDK will then be downloaded to your computer via Steam.

Running

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.

When you first run the SDK it will spend a long time extracting its downloaded archive to loose files on 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 by launching the game and quitting once you get to the main menu.

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