View source for Gameinfo.gi

{{LanguageBar}}
{{Source2 topicon}}
<center style=color:white;font-size:20px;font-weight:bold;padding:5px>Game Definition Files</center>
{{TabsBar|main=Gameinfo.txt}}
{{langsp|title={{mono|gameinfo.gi}}}}{{Toc-right}}

{{Code|preset=2|GameInfo.gi}} is a [[KeyValues]] config file that describes a Source 2 games/mod. Most of the basic are slightly different compared to the [[Gameinfo.txt|Source 1 counterpart (gameinfo.txt)]], and Source 2 also introducing new keyvalues and subkey. For example, {{code|preset=2|GameInfo.gi}} can contain a Source 2 equivalent of an "{{code|preset=2|[[autoexec.cfg]]}}", which is defined in the "[[#convarref|ConVars]]" KeyValue. 

{{Note|[[Boolean]]s 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|intn=0|Game|string|The name of the mod in [[w:ASCII|ASCII]]. Displayed in Steam and used as the window title. Only displayed in the main menu if {{Code|preset=1|Title}} isn’t specified.}}
{{KV|intn=0|Title|string|A [[w: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|preset=1|Title}}, but append either 2 or a higher number onto it. {{Note|The higher the number, the further down the text will be.}} }}
{{KV|intn=0|Title_PW|string|Most likely game title in Chinese (CS2 Perfect World). Obfuscated using unknown Unicode encoder.{{confirm}} {{only|{{cs2}}}} }}

===Options===
Keys that affect what tabs and options that show up in the Options panel. Also see [[Customizing Options: Keyboard]].
{{KV|intn=0|Type|string|Affects which tabs appear in which order in the Options panel, the value will either be {{Code|preset=1|Singleplayer_Only}} or {{Code|preset=1|Multiplayer_Only}}. Omit this key if your mod has both SP and MP modes.}}
{{KV|intn=0|NoCrosshair|boolean|Hides the multiplayer crosshair selection menu.}}
{{KV|intn=0|AdvCrosshair|boolean|Enables the special advanced crosshair options. {{Todo|How to implement.}} }}
{{KV|intn=0|NoModels|boolean|Hides the multiplayer model selection menu.}}
{{KV|intn=0|NoHIModel|boolean|Hides toggle checkbox for <code>cl_himodels</code>, which was used for multiplayer models in {{Gldsrc|4}}. Only displayed properly if <code>cl_himodels</code> exists in the first place. }}
{{Confirm|Confirm if some of these options from Source 1 still works in Source 2.}}
{{todo|Add more information and KeyValues.}}

==== {{cs2|2}} exclusive ====
{{KV|intn=0|LayeredOnMod|string|Inherits the gameinfo.gi data from specified game/mod folder.}}
{{KV|intn=0|SatelliteDir|string|Unknown. Specified as {{code|csgo_gc}}.}}

===Engine and tools===
Keys that affect how the engine/tools runs and some options for the tools themselves.
{{KV|intn=0|Nodegraph|boolean|Whether or not to enable building [[nodegraph]]s (.ain files) for maps. Disabled in {{hla|1}}.}}
{{KV|intn=0|Tonemapping|boolean|Show Tonemapping UI in tools mode.}}
{{KV|intn=0|GameData|string|Path to a [[FGD]] file, relative to [[Valve Hammer Editor (Source 2)|Hammer’s]] location. This is needed for [[instances]] to be compiled into maps. It is not used by Hammer itself.}}
{{KV|intn=0|InstancePath|string|The default location in which to look for [[Instance]] VMFs.|since=2013}}
{{KV|intn=0|SupportsXbox360|boolean|Likely deprecated. Only present in previous version of {{cs2|1}}. Mark the game whether if it was supported on {{x360|1}} or not.|deprecated=1}}

===FileSystem===
Keys that are within the subkey <code>FileSystem</code>.
{{KV|intn=0|SteamAppID|int|The Steam [[Steam Application IDs|AppID]] of the game. On Source 2 this is likely not needed, and only present in {{code|gameinfo.gi}} on {{path|core}} folder (using non-existent/private AppID "890", aswell as {{path|csgo_core}} in CS2, which uses the old [https://steamdb.info/app/710 CS:GO Beta Dev] AppID).
{{Note|Your mod won’t be protected by {{vac|2}} if it is based on a singleplayer game.}}
}}
{{KV|intn=0|ToolsAppId|int|This is the AppID of the SDK currently in use. Deprecated and leftover from Source. Only present in {{code|gameinfo.gi}} on {{path|core}} folder (using non-existent/private AppID "895"_ |deprecated=1}}

====SearchPaths====
{{Note|Lots of stuff has been changed in Source 2, and since Source 2 was built from Source 1's {{l4dbranch|1}} and above. It may not support mounting VPK files with name other than {{code|pak01_xxx.dir}} for example.
{{Confirm|Confirm whether some Source 1 stuff still works in Source 2, such as "<nowiki>|All_Source_Engine_Paths|</nowiki>".}}
}}
<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.

Loadorder is defined by two things: Primarily, whether files are in a VPK or not, and secondarily the "Top-Down" order in which the Search paths are listed.

The absolute highest priority over everything is given to whichever vpk file (such as hl2_misc_dir.vpk or pak01_dir.vpk) is highest in the search path. Even if it is the third path in the list, VPK has priority.

All subsequent vpk files according to the Gameinfo.txt's "Top-Down" rule will load all data that has not yet been found in the previous VPK file(s).

Once all VPK files are loaded, it goes back to the top most search path and loads any loose files that are not yet in any VPK file. Then it continues along the Gameinfo.txt's "Top-Down" rule to check for any additional loose files not yet loaded.

====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.gi or absolute. A example of each one respectively would be this:

{{CodeBlock|<nowiki>Game	hlvr	// Mount a folder called "hlvr" (for Half-Life: Alyx) in it.
Game				core // Mount Source 2's "core" folder.
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.</nowiki>}}

In Source 2, mounting a directory will also mount the VPKs inside it.

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|4}}, 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:

{{CodeBlock|<nowiki>// 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</nowiki>}}

Here is also an example of how to mount a [[Modification|SourceMod]]:

{{CodeBlock|<nowiki>// 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</nowiki>}}

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

{{CodeBlock|<nowiki>// Mount both |All_Source_Engine_Paths| and |GameInfo_Path| variables' path.
Game	|All_Source_Engine_Paths|.
Game	|GameInfo_Path|.</nowiki>}}


* <code>/*</code> <br> Mount every sub-folder and [[VPK]] in the current directory, this command is what makes the custom folder work in most up-to-date Source games. An example of its use:

{{CodeBlock|<nowiki>// Mount the custom folder's sub-folders and VPKs.
Game	|GameInfo_Path|custom/*</nowiki>}}

===Keys===
Source 2, like {{Src13|1}}, introduces few new keys that add more control.

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, including VPKs. Core engine files (located in {{path|core}} folder), are also mounted after the game folder.
* <code>Game_LV</code> {{Cs2|only}} <br> Marks the directory as leading to Low Violence files.
* <code>Mod</code> <br> Marks the search path as a Mod path.  This is usually where GameInfo.gi is.
* <code>Write</code> <br> Marks the search path as a write path.  This is usually where GameInfo.gi is.  It marks the directory as the default directory for writing for this game.
* <code>Default_Write_Path</code> <br> Marks the search path as a Default write path.  This is usually where GameInfo.gi is.  It marks the directory as the default directory for writing config.cfg, node graphs, screenshots and some other files for this mod.  Also a fallback for when Write isn’t specified.{{confirm}}
* <code>AddonRoot</code> <br> Mount game addons located in specified folder. Usually set to {{code|game_name_addons}}.

== New KeyValues ==
This section contains new keyvalues introduced in Source 2.
=== Engine2 ===
==== {{cs2|name}} ====
* <code>DepotBuildDateTimeInTitleBar</code> <br> Show depot build date & time in titlebar.
* <code>InitFilterTextEarly</code> <br> Unknown
* <code>CNPW</code> <br> Unknown, has a password for something.
* <code>LvConfig</code> <br> Low violence config?
==== {{hla|name}} ====
* <code>HasModAppSystems</code> <br> 
* <code>Capable64Bit</code> <br> Mark if the game is 64-bit capable.
* <code>URLName</code> <br> Website name? Set to "hlvr" (same as game/mod folder) in {{hla|1}} 
* <code>UsesPanorama</code> <br> Mark if the game use [[Panorama]].
* <code>UsesBink</code> <br> Mark if the game use [[Bink]].
* <code>PanoramaUIClientFromClient</code> <br> 
* <code>RenderingPipeline</code>
** <code>SkipPostProcessing</code></br> - Skip rendering post processing effect?
** <code>PostProcessingInMainPipeline</code></br>
** <code>TonemappingVRForward</code></br> 
** <code>Tonemapping_UseLogLuminance</code></br> 
** <code>ToolsVisModes</code></br> 
** <code>OpaqueFade</code></br> 
** <code>AmbientOcclusionProxies</code></br> 
** <code>RetinaBurnFx</code></br> - Renders retina burn effect.
* <code>MSAADefaultNonVR</code> <br> - Changes [[MSAA]] sample count (or disable it), when the game runs in non-VR mode.
* <code>SuppressNonConsoleVGuiInVR</code> <br> Supress non-console VGUI in VR

=== <span id="convarref"></span>ConVars ===
Executes the [[console variable]] when starting the game.

In {{cs2|1}} for example, grass quality, Steam Audio and other commands are set to specific value and FPS are capped to 400.

=== Hammer ===
Contains KeyValues for {{hammer5|4.1}}.

=== SupportedLanguages ===
List of languages supported by the game.

== Examples ==
==={{cs2|4}} Example===
A GameInfo.gi from {{cs2|4}}.

{{Note|Last retrieved Jan 28, 2025.</br>Build date: Jan 21, 2025}}

{{CodeBlock|1=<nowiki>"GameInfo"
{
	// ********************************************************************************
	// ********************************************************************************
	// ********************************************************************************
	// DO NOT EDIT THIS FILE DIRECTLY - YOU PROBABLY WANT TO EDIT CSGO_CORE/GAMEINFO.GI
	// ********************************************************************************
	// ********************************************************************************
	// ********************************************************************************

	game 		"Counter-Strike 2"
	title 		"Counter-Strike 2"
	title_pw	"E58F8DE68190E7B2BEE88BB1EFBC9AE585A8E79083E694BBE58ABF"
	
	LayeredOnMod	csgo_imported
	SatelliteDir	csgo_gc

	FileSystem
	{
		SearchPaths
		{
			Game_LowViolence	csgo_lv // Perfect World content override

			Game	csgo
			Game	csgo_imported
			Game	csgo_core
			Game	core

			Mod		csgo
			Mod		csgo_imported
			Mod		csgo_core

			AddonRoot			csgo_addons

			LayeredGameRoot		"../game_otherplatforms/etc" [$MOBILE || $ETC_TEXTURES] //Some platforms do not support DXT compression. ETC is a well-supported alternative.
			LayeredGameRoot		"../game_otherplatforms/low_bitrate" [$MOBILE]
		}

		"UserSettingsPathID"	"USRLOCAL"
		"UserSettingsFileEx"	"cs2_"
	}

	Engine2
	{
		"DepotBuildDateTimeInTitleBar" "1"
		"InitFilterTextEarly" "1"
		"CNPW"	"CD535060BE7CF1821AFF685103743B65BF52"
		"LvConfig"	"0"
	}
	
	InputSystem
	{
		"ButtonCodeIsScanCode"		"1"
		"LockButtonCodeIsScanCode"	"1"
	}

	pulse
	{
		"pulse_enabled"					"1"
	}

	DelayedConCommands
	{
		"connect_lobby" "1"
		"connect" "1"
		"playcast" "1"
		"csgo_econ_action_preview" "1"
		"csgo_download_match" "1"
		"playdemo" "1"
		"gcconnect" "1"
	}

	ConVars
	{
		// Bandwidth control default: 300,000 Bps
		"rate"
		{
			"min"		"98304"
			"default"	"786432"
			"max"		"1000000"
		}
		"sv_minrate"	"98304"
		"sv_maxunlag"	"0.200"

		"cl_interp_ratio" "0"

		// GOTV controls
		"tv_secret_code"		"0"
		"tv_relay_secret_code"	"0"
		"tv_update_hibernation_enabled" "0"

		// Performance
		"sv_parallel_checktransmit"		"2"
		"fps_max"		"400"
		"fps_max_ui"
		{
			"default"	"200"
			"version"	"2"
		}
		"r_add_views_in_pre_output"		"1"

		// Nav fixups
		"nav_path_fixup_climb_up_segments" "1"
		"nav_gen_agent_radius_buffer" "0.75"
		"nav_gen_jump_connection_min_overlap_ratio" "0.1"

		// CSM override
		"csm_slope_scale_db_override" "3"
		
		// SSAO customization for CSGO (this is used on viewmodels)
		"r_ssao_radius"				"8"
		"r_ssao_strength"			"3"
		"r_ssao_bias"				"2.5"

		// this cache kills performance due to mutex contention
		"bone_decode_cache_enabled" "0"

		// Disable warning about oscillating panorama classes
		"panorama_classes_oscillation_warning" "0"

		// Spew warning when adding/removing classes to/from the top of the hierarchy
		"panorama_classes_perf_warning_threshold_ms" "0.75"

		// Panorama - enable render target cache
		"panorama_disable_render_target_cache" "0"

		// Panorama - enable minidumps on JS exceptions
		"panorama_js_minidumps" "1"

		// HLTV AutoDirector - disable it for now so that it doesn't interfere with our spectator camera during replays / hltv / demos
		// Needs to be revisited when we re-enable AutoDirector
		"spec_autodirector" "false"

		// Grass
		"r_grass_quality"				"3"
		"r_grass_alpha_test"			"1"
		"r_grass_density_mode"			"1"
		"r_grass_start_fade"			"3000"
		"r_grass_end_fade"				"3900"

		// Disable smooth morph normals
		"r_smooth_morph_normals"		"0"

		// Default to binding keys based on keyboard position instead of key name
		"input_button_code_is_scan_code"		"1"
		"input_button_code_is_scan_code_scd"	"1"

		// Disable Cubemap Brightening
		"lb_cubemap_normalization_max" 		"1"

		// For low quality shaders, cubemap bounds are scaled by this percentage of the fade region
		"lb_low_quality_shader_fade_region_rescale"	"0.5"
		
		// Use normal quality compression even in MET, this makes compiles in MET slower than
		// the default of fastest (0), but reduces artifacts that are confusing to artists since 
		// it's not clear that texture compression quality is different in MET than when regularly compiled.
		"rc_default_texture_encode_quality" "2"

		// The engine default of 50 for CS:GO is too high, drop down to a more sensible 
		// default value.
		"mouse_pitchyaw_sensitivity"	"3"
		"pitch_extra_mouse_sensitivity"	"1.0"

		"r_size_cull_threshold"			"0.33"
		"r_size_cull_threshold_fade"	"7.5"
		"inferno_scorch_decals" "0"

		// Steam Audio project specific convars
		"snd_musicvolume"
		{
			"version"	"2"
		}
		"snd_steamaudio_enable_custom_hrtf"					"0"
		"snd_steamaudio_enable_perspective_correction"		"1"
		"snd_steamaudio_perspective_correction_factor"		"1.0"
		"snd_steamaudio_normalize_default_hrtf_volume"		"1"
		"snd_steamaudio_default_hrtf_volume_gain"			"0.0"
		"snd_hrtf_distance_behind"							"50"
		"snd_steamaudio_max_hrtf_normalization_gain_db"		"6.0"
		"snd_steamaudio_enable_pathing"						"1"
		"snd_steamaudio_source_pathing_debug"				"0"

		"snd_event_browser_default_stack"			"csgo_mega"
		"snd_event_browser_default_vsnd_field"		"public.vsnd_files_track_01"


		// Need much tighter sound clock sync
		"snd_delay_sound_ms_max"	"40"

		//don't let people miss with speaker config settings.
		"speaker_config"
		{
			"min"		"-1"
			"default"	"-1"
			"max"		"-1"
		}

		"cl_disconnect_voice_fade"	"-1.0"
		"cl_disconnect_soundevent"	"StopSoundEvents.StopAllExceptMusic"
		
		// Physics specific customization
		"phys_use_position_based_toi_test" "1"

		// VOIP Settings.
		"voice_in_process"	"1"
		"voice_threshold"
		{
			"version" "2"
		}

		"sv_long_frame_ms" "15"
		"cq_buffer_bloat_msecs_max" "64"
	}

	// Temporarily allowing this because the particle files that are tripping this up ALSO crash PET so I 
	// cannot fix them. We'll sort this out Monday 2/13/23.
	//ResourceCompiler
	//{
	//	// See csgo_imported's gameinfo.gi
	//	"DeprecatedBehaviorVersionsAllowed"	"0"
	//}

	GMS
	{
		"Advertise"										"1"
		"RequireLoginForDedicatedServers"				"1"
	}
	
	GameInstructor
	{
		"SaveToSteamStats" "1"
	}

	SupportedLanguages
	{
		"brazilian" "3"
		"bulgarian" "3"
		"czech" "3"
		"danish" "3"
		"dutch" "3"
		"english" "3"
		"finnish" "3"
		"french" "3"
		"german" "3"
		"greek" "3"
		"hungarian" "3"
		"italian" "3"
		"indonesian" "3"
		"japanese" "3"
		"koreana" "3"
		"latam" "3"
		"norwegian" "3"
		"polish" "3"
		"portuguese" "3"
		"romanian" "3"
		"russian" "3"
		"schinese" "3"
		"spanish" "3"
		"swedish" "3"
		"tchinese" "3"
		"thai" "3"
		"turkish" "3"
		"ukrainian" "3"
		"vietnamese" "3"
	}
	
	CS2WorkshopManager
	{
		"RequiredTag" "CS2"
		"HighlightEntriesMissingRequiredTag" "1"
	}
	
	AssetBrowser
	{
		retail_filter0		"characters/models/"
		retail_filter1		"materials/decals/sprays/"
		retail_filter2		"panorama/"
		retail_filter3		"patches/"
		retail_filter4		"stickers/"
		retail_filter5		"weapons/"
		retail_filter6		"materials/models/inventory_items/"
	}

	AddonConfig	
	{
		"VpkDirectories"
		{
			"exclude"       "maps/content_examples"
			"include"       "maps"
			"include"       "cfg/maps"
			"include"       "materials"
			"include"       "models"
			"include"       "panorama/images/overheadmaps"
			"include"       "panorama/images/map_icons"
			"include"       "particles"
			"include"       "resource/overviews"
			"include"       "scripts/vscripts"
			"include"       "sounds"
			"include"       "soundevents"
			"include"       "lighting/postprocessing"
			"include"       "postprocess"
			"include"       "addoninfo.txt"
		} 
		"AllowAddonDownload" "1"
		"AllowAddonDownloadForDemos" "1"
		"DisableAddonValidationForDemos" "1"
	}
}
</nowiki>}}

== Gameinfo_branchspecific.gi ==
{{CodeBlock|1=<nowiki>"GameInfo"
{
	// this file is intentionally empty for generating depot signatures
	FileSystem
	{
		EmptyFileSystemValue 1
	}
}
</nowiki>}}
{{seealso|[[:Category:Gameinfo.gi]]}}

[[Category:File formats]]
[[Category:Modding]]
[[Category:Source 2]]