This page is a index to the software documentation. Click here for more information.
This article's documentation is for anything that uses the Source engine. Click here for more information.
This page has been semi-protected so that only established users can edit it.

SDK Docs: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(rv. what makes you think a developer wouldn't need these pages?)
No edit summary
 
(188 intermediate revisions by 69 users not shown)
Line 1: Line 1:
__NOTOC__
{{Source topicon}}
__NOEDITSECTION__
{{DIP topicon}}
{{semi-protection}}


[[Image:SourceLogo_trans.gif|center|Source]]
{{LanguageBar|title = Source SDK Documentation}}


==General==
{{Background
* [[SDK Installation|Downloading and Installing the Source SDK]]
| file = SDK - Background.png
* [[Source SDK Release Notes]]
| gradient-height = 600px
* [[:Category:Source SDK FAQ|Source SDK Frequently Asked Questions]]
| opacity = 13%
* [[Source SDK Known Issues]]
}}
* [[Help Desk]]
* [[Developer Console]]
* [[Source SDK Files and Directory Structure]]
* [[Demo Recording Tools]]
* [[SourceTV]]
* [[Books]]


{{Table
| width = 700px
| align = center
| style = border-color:{{src2|col}}4a;
| caption indent:top = 1em
| caption = [[File:Source-logo.png|400px|link=Source|Click here for more information about the Source Engine.]]
<p style="font-size:14px; text-align:center; padding:0 1em; margin:1.25em auto 1.5em auto"> '''The {{srcsdk|3.1.nolink}} is freely available to all Steam users.''' It is used to develop mods and content for the [[Source 2006]], [[Source 2007]], [[Source 2013]] and {{tf2branch|1}} engine branches. </p>
<p style="margin:10px 0 10px; font-size:14px">'''[[SDK Installation|Download and Installation]]&ensp;·&ensp;[https://partner.steamgames.com/doc/sdk/uploading/distributing_source_engine <span style="color:#648CC8">Distributing Source mods</span>]&ensp;·&ensp;[[:Category:Source SDK FAQ|Frequently Asked Questions]]&ensp;·&ensp;[[Source SDK Release Notes|Release Notes]]'''</p>
| {{tr
| bgcolor = #252525
| {{td|radius=3px 0 0 0|align=center|font-size=14px|bgcolor=#2F2A26|width=225px| '''[[:Category:Modding|<span style="color:#E3C798">Modding</span>]]''' }}
  {{td|radius=0 3px 0 0| Creating, organizing and releasing your {{Source|1}} project. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Level Design|<span style="color:#E3C798">Level Design</span>]]''' }}
  {{td| [[Map (level design)|Maps]] are the 3D worlds where everything comes together. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Programming|<span style="color:#E3C798">Programming</span>]]''' }}
  {{td| text = A mod's C++ '''code''' defines the way its world and game rules behave. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Scripting|<span style="color:#E3C798">Scripting</span>]]''' }}
  {{td| Scripting can be used for adding new functionality or logic to [[Entity|entities]]. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Modeling|<span style="color:#E3C798">Modeling</span>]]'''}}
  {{td| [[Model|Models]] are the detailed 3D objects that appear in the game world. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Material System|<span style="color:#E3C798">Materials</span>]]''' }}
  {{td| [[Texture|Textures]] and [[Shader|shaders]] are combined in {{Source|bold}} to create [[Material|materials]]. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Sound System|<span style="color:#E3C798">Sounds</span>]]''' }}
  {{td| Quality [[Sound and Music|audio]] adds a fourth dimension to your world. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Particle System|<span style="color:#E3C798">Particles</span>]]''' }}
  {{td| Effects like smoke, sparks, blood and fire are created with [[Particle System Overview|particles]]. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:AI|<span style="color:#E3C798">Artificial Intelligence</span>]]''' }}
  {{td| AI controls the behavior of all but the simplest of [[NPC|NPC]] actions. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Choreography|<span style="color:#E3C798">Choreography</span>]]''' }}
  {{td| Direct your digital actors' performances with [[Choreography creation|choreographed scenes]]. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Source Filmmaker|<span style="color:#E3C798">Filmmaker</span>]]''' }}
  {{td| Create movies inside the {{Source|bold|nt=1}}. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Tutorials|<span style="color:#E3C798">Tutorials</span>]]''' }}
  {{td| Step-by-step guides on a variety of topics. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Technical|<span style="color:#E3C798">Technical</span>]]''' }}
  {{td| In-depth discussion on the {{Source|bold|nt=1|addtext='s}} features. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Glossary|<span style="color:#E3C798">Glossary</span>]]''' }}
  {{td| text = Explanations for '''terms''' you may encounter. }}
}}
{{tr
| bgcolor = #252525
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Official Source Tools|<span style="color:#E3C798">Official Tools</span>]]''' }}
  {{td| Official tools made by {{Valve|1}} for their games. }}
}}
{{tr
| bgcolor = #202020
| {{td|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:Third Party Source Tools|<span style="color:#E3C798">Third-Party Tools</span>]]''' }}
  {{td| text = Useful developer tools created by the '''community'''. }}
}}
{{tr
| bgcolor = #252525
| {{td|radius=0 0 0 3px|align=center|font-size=14px|bgcolor=#2F2A26| '''[[:Category:IO System|<span style="color:#E3C798">I/O System</span>]]''' }}
  {{td|radius=0 0 3px 0| The [[Inputs and Outputs|I/O system]] is the backbone of most levels in Source-based games/mods. }}
}}
}}


{| align="center"
{{Table
!colspan="2"| <center>Quick Category Navigation</center>
| width = 700px
|-
| align = center
| '''[[:category:Modding|Modding]]'''
| style = border-color:{{src2|col}}4a; margin-top:1em;
| Creating, organising and releasing your Source project.
| {{tr
|-
| style=background-image:linear-gradient(0deg, #4F3D1F, #614b26);
| '''[[:category:Level Design|Level Design]]'''
| align=center
| Maps are the cornerstone of Source, where it all comes together. Learn about all aspects of producing them here.
| {{td|radius=3px 3px 0 0|font-size=14px|color=#FFFFFF|width=225px| '''List of game-specific documentation indexes''' }}
|-
}}
| '''[[:category:Choreography|Choreography]]'''
{{tr
| Make Source's characters come to life with its uniquely powerful choreography technologies.
| bgcolor = #252525
|-
| align=center
| '''[[:category:AI|AI]]'''
| {{td|font-size=14px|text= <span style="pointer-events:none">{{tf2}}</span> [[Team Fortress 2/Docs|Team Fortress 2]]{{·}} <span style="pointer-events:none">{{l4d}}</span> [[Left 4 Dead/Docs|Left 4 Dead]]{{·}} <span style="pointer-events:none">{{l4d2}}</span> [[Left 4 Dead 2/Docs|Left 4 Dead 2]]{{·}} <span style="pointer-events:none">{{p2}}</span> [[Portal 2/Docs|Portal 2]] }}
| AI controls the behavior of all but the simplest of NPC actions and Source makes using or creating it easy.
}}
|-
{{tr
| '''[[:category:Material System|Material System]]'''
| bgcolor = #202020
| Textures and shaders are combined in Source to create materials.
| align=center
|-
| {{td|radius=0 0 3px 3px|font-size=14px| Didn't find the game you wanted? See the [[:Category:Documentation index pages|full list]] → }}
| '''[[:category:Sound System|Sound System]]'''
}}
| Documentation on Source's software sound system.
}}
|-
| '''[[:category:Modeling|Modeling]]'''
| Everything you need to know about modeling for Source.
|-
| '''[[:category:VGUI|VGUI]]'''
| Valve's proprietary GUI mimics Windows' and works both in-game and on the desktop. Used for HUDs, 3D cameras and more.
|-
| '''[[:category:Programming|Programming]]'''
| The nuts and bolts of any MOD, programming is what makes things different.
|-
| '''[[:category:Snippets|Code Snippets]]'''
| Bits of code that are useful but aren't enough for a tutorial.
|-
| '''[[:Category:Tutorials|Tutorials]]'''
| Need help trying to use a particular Source feature? Check here.
|-
| '''[[:category:Technical|Technical]]'''
| Miscellaneous technical aspects about the Source engine and Half-Life 2 programming.
|-
| '''[[:Category:Glossary|Glossary]]'''
| Explanations of common terms.
|-
| '''[[:Category:Third Party Tools|Third Party Tools]]'''
| Non-Valve developer tools.
|}


{{otherlang:en}}
<div style="max-width:700px; margin:0 auto">{{SDKDocIndexList}}</div>
{{otherlang:en:de|SDK Docs:de}},
 
{{otherlang:en:es|SDK Docs:es}},
[[Category:Source]]
{{otherlang:en:sv|SDK Docs:sv}},
[[Category:Entry pages]]
{{otherlang:en:fr|SDK Docs:fr}},
{{otherlang:en:cs|SDK Docs:cs}}.<br/>
<small>Other pages available in:</small>
{{otherlang:en:zh-cn|:Category:Chinese}},
{{otherlang:en:jp|:Category:Japanese}},
{{otherlang:en:pl|:Category:Polish}},
{{otherlang:en:ru|:Category:Russian}},
{{otherlang:en:zh-tw|:Category:Tranditional Chinese}}

Latest revision as of 03:59, 16 July 2025

English (en)Deutsch (de)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文（臺灣） (zh-tw)Translate (Translate)
SDK - Background.png
Click here for more information about the Source Engine.

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

Download and Installation · Distributing Source mods · Frequently Asked Questions · Release Notes
Modding Creating, organizing and releasing your Source project.
Level Design Maps are the 3D worlds where everything comes together.
Programming A mod's C++ code defines the way its world and game rules behave.
Scripting Scripting can be used for adding new functionality or logic to entities.
Modeling Models are the detailed 3D objects that appear in the game world.
Materials Textures and shaders are combined in Source to create materials.
Sounds Quality audio adds a fourth dimension to your world.
Particles Effects like smoke, sparks, blood and fire are created with particles.
Artificial Intelligence AI controls the behavior of all but the simplest of NPC actions.
Choreography Direct your digital actors' performances with choreographed scenes.
Filmmaker Create movies inside the Source Engine.
Tutorials Step-by-step guides on a variety of topics.
Technical In-depth discussion on the Source Engine's features.
Glossary Explanations for terms you may encounter.
Official Tools Official tools made by Valve for their games.
Third-Party Tools Useful developer tools created by the community.
I/O System The I/O system is the backbone of most levels in Source-based games/mods.
List of game-specific documentation indexes
Team Fortress 2 Team Fortress 2 · Left 4 Dead Left 4 Dead · Left 4 Dead 2 Left 4 Dead 2 · Portal 2 Portal 2
Didn't find the game you wanted? See the full list →
 
List of SDK documentation indices
ViewDiscussEdit templatePurge
GoldSrc GoldSrc
Source Source
Source 2 Source 2
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=SDK_Docs&oldid=485199"