User:Lost Saga TW: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Replaced content with "<p><a href="https://developer.valvesoftware.com/wiki/File:ValveLogo.gif#/media/File:ValveLogo.gif"><img src="https://developer.valvesoftware.com/w/images/c/c5/ValveLogo.gi...")
Tag: Replaced
Line 1: Line 1:
Lost Saga TW
<p><a href="https://developer.valvesoftware.com/wiki/File:ValveLogo.gif#/media/File:ValveLogo.gif"><img src="https://developer.valvesoftware.com/w/images/c/c5/ValveLogo.gif" alt="ValveLogo.gif" height="49" width="180"></a><br><a href="https://developer.valvesoftware.com/w/index.php?curid=1492">Link</a></p>
Level Developer
{{otherlang2
|noborder=true
|cs=Main_Page:cs
|es=Main_Page:es
|de=Main_Page:de
|fr=Main_Page:fr
|ka=Main_Page:ka
|nl=Main_Page:nl
|ru=Main_Page:ru
|sv=Main_Page:sv
|zh-cn=Main Page:zh-cn
}}__NOTOC__
Welcome to the Valve Developer Community. Whether you're building a "Triple-A" commercial project or a [[mod]] for [http://www.half-life2.com Half-Life® 2], you'll want to [[Special:Userlogin|sign up]] as a Valve developer today. It's free to join, and open to anyone working with the [[Source Engine Features|Source Engine]] and the [[SDK Installation|Source SDK]].
 
[[File:Doublearrow.png|link=]] [[Special:Userlogin|'''Sign up to become part of the community!''']]
{| cellspacing="0" style="border:0px;"
|- valign="top"
| style="width:60%;padding-right:1.5em"|
 
== Source and the Source SDK ==
<div class="capsule" style="background:#4a6821;-moz-border-radius:5px;-webkit-border-radius:5px;-khtml-border-radius:5px;border-radius:5px;">
<div class="capcontent" style="background:#4a6821;padding:6px">
[[File:Doublearrow_white.png|link=]] [[SDK Docs|<span style="color:white;">'''Go to the Source Engine documentation index'''</span>]]
</div>
{{otherlang2
|es=The_GameInfo.txt_File_Structure:es
|fr=The_GameInfo.txt_File_Structure:fr
|ru=The_GameInfo.txt_File_Structure:ru
|pl=The_GameInfo.txt_File_Structure:pl
|jp=The_GameInfo.txt_File_Structure:jp
|de=The_GameInfo.txt_File_Structure:de
|zh-cn=The_GameInfo.txt_File_Structure:zh-cn
|ko=Gameinfo.txt:ko
}}
 
:''For Half-Life 1/[[GoldSrc]], see [[The liblist.gam File Structure|liblist.gam]].''
 
{{toc-right}}
 
'''<code>GameInfo.txt</code>''' is a [[KeyValues]] config file that describes a Source mod. Apart from containing metadata like the name of the mod or a link to the developer's website, it also defines which games it depends on and the '''SearchPaths''' that the engine uses to look up resources. It is stored in the mod's root folder. Source, the SDK tools and Steam rely on it.
 
{{warning|GoldSource games do not have GameInfo.txt files! Use Hammer 3.4 to edit Half-Life maps.}}
 
{{note|Booleans are represented as 0 or 1.}}
{{note|If a string contains spaces or tabs you have to wrap it in "quote marks".}}
 
== Basic settings ==
 
=== Name ===
 
Keys that affect the menu and window title.
 
 
{{KV|Game|string|The name of the mod in [[Wikipedia:ASCII|ASCII]]. Displayed in Steam and used as the window title. Only displayed in the main menu if <code>Title</code> isn't specified.}}
{{KV|Title|string|A [[Wikipedia:Unicode|Unicode]] string displayed in the main menu of your mod.  You can also new line the menu text by adding another key of the same name <code>Title</code>, but append either 2 or a higher number onto it. {{note|The higher the number, the further down the text will be.}} }}
; {{KV|GameLogo|boolean|Rather than displaying the <code>Title</code> text on the main menu, display the content in <code>resource\GameLogo.res</code>. See [[Adding Your Logo to the Menu]].|since=EP2}}
 
=== Options ===
 
Keys that affect what tabs and options that show up in the Options panel.  Also see [[Customizing Options: Keyboard]].
 
 
{{KV|Type|string|Affects which tabs appear in which order in the Options panel, the value will either be <code>Singleplayer_Only</code> or <code>Multiplayer_Only</code>. Omit this key if your mod has both SP and MP modes.}}
{{KV|NoDifficulty|boolean|Hides the difficulty tab (this happens automatically if your mod is <code>Multiplayer_Only</code>.)}}
{{KV|HasPortals|boolean|Shows the Portal options tab.|since=EP2}}
{{KV|NoCrosshair|boolean|Hides the multiplayer crosshair selection menu.}}
{{KV|AdvCrosshair|boolean|Enables the special advanced crosshair options. {{todo|How to implement.}} }}
{{KV|NoModels|boolean|Hides the multiplayer model selection menu.}}
{{KV|NoHIModel|boolean|Hides toggle checkbox for <code>cl_himodels</code>, which was used in [[GoldSource]]. Only displayed properly if <code>cl_himodels</code> exists in the first place.}}
{{KV|Hidden_Maps|subkey|Maps in the subkey do not appear in the "Create a Server" dialogue. Does not stop users from being able to load them from the console though.  Syntax is <code>mapname 1</code>, with one entry per line. Don't include <code>.bsp</code>. Remember to open and close the subkey with { and }. }}
 
=== Steam games list ===
 
Keys that affect how your game or mod shows up in the Steam Library page.
 
 
{{KV|Developer|string|The developer of the mod. Usually either the Mod Team's name, or a single person's name.}}
{{KV|Developer_URL|string|Your or the mod's URL. Must start with <code><nowiki>http://</nowiki></code>.}}
{{KV|Manual|string|URL to the mod's manual; can also be a local file.}}
{{KV|Icon|string|Local path relative to GameInfo.txt, to an uncompressed 16x16 TGA that will appear as your mod's icon in Steam. Do ''not'' include the file extension. The larger 32px pixel icon that appears in Steam's Detail View should be placed next to the 16px one and called <code>&lt;icon&gt;_big.tga</code>. {{note|For transparency to work, the TGA must be saved in 32-bit mode with active alpha channel.}} }}
 
=== Engine and tools ===
 
Keys that affect how the engine/tools runs and some options for the tools themselves.
 
 
{{KV|Nodegraph|boolean|Whether or not to enable building [[nodegraph]]s (.ain files) for maps.|since=EP2}}
{{KV|GameData|string|Path to a [[FGD]] file, relative to [[Hammer]]'s location. This is needed for [[instances]] to be compiled into maps. It is not used by Hammer itself.}}
{{KV|InstancePath|string|The default location in which to look for [[Instance]] VMFs.|since=2013}}
{{KV|SupportsDX8|boolean|When false, prevents the game from being ran in older [[DirectX_Versions|DirectX Versions]] such as DX8 and below, since they do not support the full range of graphic effects, also prevents [[Studiomdl]] from producing <code>.sw.vtx</code> and <code>.dx80.vtx</code> files for models, as they aren't needed.|since=L4D}}
{{KV|SupportsVR|boolean|Whether or not the game supports being ran in VR mode.|since=2013}}
{{KV|SupportsXBox360|boolean|Whether or not the game supports Xbox 360. {{confirm|Does this enable being able to use a Xbox 360 controller with the game?}}|since=L4D}}
 
=== FileSystem ===
 
Keys that are within the subkey <code>FileSystem</code>.
 
 
{{KV|SteamAppID|int|The [[Steam Application IDs|AppID]] of the game the mod is to be based on. The mod will have access to all of this game's content, and will not be playable unless it is installed, the mod will also be ran with the game's executable as well.  If you're uploading your Source game to Steam, this will be your game's AppID.  Otherwise, this will be 243750 for Source 2013 Multiplayer, 243730 for Source 2013 Singleplayer, 630 for [[Alien Swarm]], or the AppID of the game you're basing it off of if you're not working with source code.
{{note|Most older Source mods will use AppID 215 for Source 2006 and 218 for Source 2007.  If your making a new mod, you shouldn't use these IDs as they're for a obviously deprecated Source engine branch that was replaced by Source 2013 and Alien Swarm.  Only use them for legacy support.}}
{{note|Your mod won't be protected by [[VAC]] if it is based on a singleplayer game.}} }}
 
{{KV|AdditionalContentId|int|Another AppID that the mod has access to. This feature was added to the SDK source code but somehow never made it to Valve's other games; you will have to build your own binaries to use it. If you need to mount multiple apps using this, [[Mounting multiple games|make these changes]].
{{bug|The engine understands this command, but the SDK tools unfortunately do not. The best solution, currently, is to copy the content of the game to a location on your hard drive and add an absolute <code>SearchPath</code> to it. Remember to delete the SearchPath before you release.}} |deprecated=1}}
{{KV|ToolsAppId|int|This is the AppID of the SDK currently in use.|deprecated=1}}
 
== SearchPaths ==
 
<code>SearchPaths</code> is a subkey within <code>FileSystem</code>. It contains a key for every search path. When the engine needs a file it traverses the search paths, stopping when the desired file has been found, hence the order of the search paths is important.
 
 
{{note|A thing to keep in mind, is the order that you put the search paths in is ''important'', if there are 2 files of the same name that are in 2 different search paths, and you list them both, the search path at the top will win, and use that file.}}
 
=== Directories ===
 
The directory, which is the value of the key, will either be relative to the <code>SteamAppID</code>'s root directory (i.e. where the executable of the game is located), relative to GameInfo.txt or absolute.  A example of each one respectively would be this:
 
Game      |All_Source_Engine_Paths|HL2 // Go to the executable directory, and mount a folder called HL2 in it.
Game      |GameInfo_Path|. // Go to the directory of where GameInfo.txt is located, and mount the folder it's in.
Game      "C:\MyFolderOfContent\content" // Mount this absolute directory, useful for mounting content temporarily.
 
{{note|In order to mount a [[VPK]] file, you need to add the VPK's name at the end of the directory with the <code>.vpk</code> extension. If the VPK is a multi-chunck VPK, then put the name of the VPK in without the "_dir" or "_###" at the end.}}
 
The 2 variables above will start the search in a certain directory, <code>|All_Source_Engine_Paths|</code> will start the directory within the root folder, and <code>|GameInfo_Path|</code> will start it in the folder where GameInfo.txt is located.  Both of these variables can be appended with any number of folders.  There are also some special commands you can append in addition to the folders and variables, the known ones are:
 
 
 
* <code>../</code> <br> Goes back one folder, this will useful for mounting other games' content like [[Portal]], since AdditionalContentID is deprecated.  If you wanted to mount Portal, and your game is in, say for example <code>"<SteamFolder>\SteamApps\Common\MyGame\FolderWhereGameInfoIs"</code>, you would create a search path like this to mount it's content:
 
// Start in the executable directory, then go back one folder so we're in Common, and then go into Portal/portal and mount portal_pak.vpk
Game      |All_Source_Engine_Paths|../Portal/portal/portal_pak.vpk
 
 
Here is also an example of how to mount a [[Modification|SourceMod]]:
 
// Start in the executable directory, then go back two folders so we're in SteamApps, and then go into SourceMods and mount the MySourceMod folder.
Game      |All_Source_Engine_Paths|../../SourceMods/MySourceMod
 
 
* <code>.</code> <br> This stops the search in the current directory, this should only be used if you want to directly mount where <code>|All_Source_Engine_Paths|</code> or <code>|GameInfo_Path|</code> are.  An example of both:
 
// Mount both |All_Source_Engine_Paths| and |GameInfo_Path| variables' path.
Game      |All_Source_Engine_Paths|.
Game      |GameInfo_Path|.
 
 
* <code>/*</code> <br> Mount every sub-folder and [[VPK]] in the current directory, this command is what makes the custom folder work in most update to date Source games.  An example of it's use:
 
// Mount the custom folder's sub-folders and VPKs.
Game      |GameInfo_Path|custom/*
 
=== Keys ===
 
In most older Source games, the only keys for search pathing is <code>Game</code> and <code>Platform</code>, while these keys will suit most search pathing, in Source 2013 a few new keys where introduced that add more control.
 
{{tip|[[Insurgency]] and [[Day of Infamy]] use the same search pathing system as Source 2013, so commands and keys that work in Source 2013 will work for them as well!}}
 
The current keys known so far are:
 
* <code>Game</code> <br> Adds the path as a simple search path.  Will add any content it finds.
* <code>Game_Write</code> {{2013 add}} <br> Marks the search path as a Game write path.  This is usually where the game executable is. It marks the directory as the default directory for writing (configuration files, etc) for this game.
* <code>GameBin</code> {{2013 add}} <br> A special key that requires that the path lead to a game's binary files (where <code>Server.dll</code> and <code>Client.dll</code> are located), and will use any other DLL files it finds.  This should lead to your own mod's <code>Bin</code> folder, or the game you're basing it off's <code>Bin</code> folder if you're not building your own DLLs.
* <code>Platform</code> <br> Adds a special search path to the folder containing core engine files, this will usually lead to the game's <code>Platform</code> folder.
* <code>Mod</code> {{2013 add}} <br> Marks the search path as a Mod path. This is usually where the game executable is. {{todo|What does this do exactly?}}
* <code>Mod_Write</code> {{2013 add}} <br> Marks the search path as a Mod write path.  This is usually where GameInfo.txt is. It marks the directory as the default directory for writing (configuration files, etc) for this mod.
* <code>Default_Write_Path</code> <br> A fallback for when either Mod_Write or Game_Write isn't specified.  This is usually where GameInfo.txt is.  {{todo|What does this "Write" exactly?}}
* <code>VPK</code> {{Contagion add}} <br> Used to mount a [[VPK]] by name.  Do not put <code>.vpk</code> at the end.
 
 
In Source 2013, you may also append keys to each other by separating each key name by a <code>+</code> sign, this way if you need to use one directory for multiple keys, instead of writing this:
 
Game      |GameInfo_Path|MyFolder
Mod      |GameInfo_Path|MyFolder
 
It can instead be shortened like this:
 
Game+Mod  |GameInfo_Path|MyFolder
 
This saves you time from having to retype the directory over again.
 
=== Automatic localization ===
 
Source automatically creates localized search paths. If you mount the folder <code>HL2</code>, then when your mod runs in French <code>HL2_French</code> is automatically mounted just above it, overriding any content in <code>HL2</code>. {{todo|Does this also apply for the mod folder?}}
 
== Example ==
A full working GameInfo.txt ready for a Source 2013 Singleplayer mod.
 
<source lang=ini>
 
GameInfo
{
Game "My Mod Name"
GameLogo 0
Nodegraph 1
Title "My Mod Title"
Developer "My Name"
Developer_URL "https://developer.valvesoftware.com/wiki/Main_Page"
Type Singleplayer_Only
SupportsDX8 0
SupportsVR 0
SupportsXbox360 0
GameData HalfLife2.fgd
FileSystem
{
SteamAppId 243730
SearchPaths
{
GameBin |All_Source_Engine_Paths|SourceTest/Bin // Using the SourceTest DLLs.
// Source 2013 Singleplayer comes with Episode 2, Episode 1, and Lost Coast content. So let's mount it.
Game |All_Source_Engine_Paths|EP2/EP2_Pak.vpk // EP2 content has the highiest priority.
Game |All_Source_Engine_Paths|Episodic/EP1_Pak.vpk
Game |All_Source_Engine_Paths|SourceTest/SourceTest_Pak.vpk // Lost Coast
// Source 2013 Multiplayer comes with HL2 Deathmatch, and Lost Coast content, so let's mount the HL2 Deathmatch content too.
Game "|All_Source_Engine_Paths|../Source SDK Base 2013 Multiplayer/HL2MP/HL2MP_Pak.vpk" // Has to be in quotes because of spaces.
Game |All_Source_Engine_Paths|HL2/HL2_Misc.vpk
Game |All_Source_Engine_Paths|HL2/HL2_Sound_Misc.vpk
Game |All_Source_Engine_Paths|HL2/HL2_Sound_VO_English.vpk // Optional, just dialog.
Game |All_Source_Engine_Paths|HL2/HL2_Textures.vpk
Game+Game_Write+Mod+Mod_Write+Default_Write_Path |GameInfo_Path|.
// These search for loose files in the folders, incase we missed anything.
Game |All_Source_Engine_Paths|EP2
Game |All_Source_Engine_Paths|Episodic
Game |All_Source_Engine_Paths|SourceTest
Game |All_Source_Engine_Paths|HL2
 
Platform |All_Source_Engine_Paths|Platform
Platform |All_Source_Engine_Paths|Platform/Platform_Misc.vpk
}
}
}
{{otherlang2
| az = SDK Installation:az
| de = SDK Installation:de
| cs = SDK Installation:cs
| es = SDK Installation:es
| fr = SDK Installation:fr
| it = SDK Installation:it
| ru = SDK Installation:ru
| tr = SDK Installation:tr
| ka = SDK_Installation:ka
| zh-cn = SDK Installation:zh-cn
| zh-tw = SDK Installation:zh-tw
| ko = SDK Installation:ko
}} {{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 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:
 
* {{Game link|Left 4 Dead Authoring Tools}}
* {{Game link|Left 4 Dead 2 Authoring Tools}}
* {{Game link|Alien Swarm SDK}} (free to all)
* {{Game link|Portal 2 Authoring Tools}}
* {{Game link|Counter-Strike: Global Offensive Authoring Tools}}
 
== 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: <code>[steam]/steamapps/common/Team Fortress 2/bin</code>) 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 ===
 
{{Steam App Install|id=211|name=Source SDK}} For future reference, or if that doesn't work:
 
# Open the Steam window.
# Go to the '''Library'''.
# Change the list to '''Tools'''.
# Find and double-click on the '''Source SDK''' item.
# Read over the dialog box and click '''Download and Install''' / '''Next''' to continue
# 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 [[SDK Docs|Source SDK documentation]] is a good place to start.
 
== Bugs and Issues ==
* Read the [[Source SDK Release Notes]] for information about the latest SDK release.
* See the [[:Category:Source SDK FAQ|Source SDK FAQ]] for answers to general SDK questions.
* For level design and Hammer editor issues, see the [[:Category:Level Design FAQ|Level Design FAQ]].
 
== See also ==
* [[Cleanly reinstalling Steam]]
 
[[Category:Source SDK FAQ]]
 
</source>
 
[[Category:File formats]]
[[Category:Modding]]
[[Category:Source SDK FAQ]]

Revision as of 10:17, 22 February 2021

<a href="https://developer.valvesoftware.com/wiki/File:ValveLogo.gif#/media/File:ValveLogo.gif"><img src="https://developer.valvesoftware.com/w/images/c/c5/ValveLogo.gif" alt="ValveLogo.gif" height="49" width="180"></a>
<a href="https://developer.valvesoftware.com/w/index.php?curid=1492">Link</a>

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=User:Lost_Saga_TW&oldid=239442"