VCFG: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
'''Configuration file''' (or '''CFG''') is a {{source2|4}} games text file used to [[exec]]ute a newline-delimited list of [[ConCommand|console command]]s to the [[Developer Console]]. The '''.cfg''' file extension can be found everywhere and is not specific to Source.
'''Valve Configuration file''' (or '''VCFG''') is a {{source2|4}} games text file used to [[exec]]ute a newline-delimited list of [[ConCommand|console command]]s to the [[Developer Console]]. The '''.cfg''' file extension can be found everywhere and is not specific to Source.


{{ModernTip|It can be useful to keep situational key[[bind]]s in files other than autoexec.cfg.}}
{{ModernTip|It can be useful to keep situational key[[bind]]s in files other than autoexec.cfg.}}
Line 19: Line 19:
! CFG !! Description
! CFG !! Description
|-
|-
| '''[[autoexec|autoexec.cfg]]''' || Ran on game start up, so one can easily create the file and put any commands that one doesn't want to type each time.
| '''[[autoexec|autoexec.vcfg]]''' || Ran on game start up, so one can easily create the file and put any commands that one doesn't want to type each time.
|-
|-
| '''modsettings.cfg''' || Ran on game start up, unless not found in mod folder.
| '''modsettings.vcfg''' || Ran on game start up, unless not found in mod folder.
|-
|-
| '''config.cfg''' || Ran on game start up, this is created automatically when the player runs the game/mod for the first time. {{note| On game quit, key binds in this file will be re-written to current bindings, so making changes to this file is most likely pointless.}}
| '''config.cfg''' || Ran on game start up, this is created automatically when the player runs the game/mod for the first time. {{note| On game quit, key binds in this file will be re-written to current bindings, so making changes to this file is most likely pointless.}}
|-
|-
| '''[[Customizing_Options:_Keyboard#cfg.2Fconfig_default.cfg|config_default.cfg]]''' || Ran when no config.cfg is present or when player clicks the 'Use Defaults' button in the keyboard tab in the options panel, see [[Customizing Options: Keyboard]].
| '''[[Customizing_Options:_Keyboard#vcfg.2Fconfig_default.vcfg|config_default.vcfg]]''' || Ran when no config.cfg is present or when player clicks the 'Use Defaults' button in the keyboard tab in the options panel, see [[Customizing Options: Keyboard]].
|-
|-
| '''chapter#.cfg''' || Ran when the player picks the chapter, with # being the chapter number, see [[Adding chapters to your mod]].
| '''chapter#.vcfg''' || Ran when the player picks the chapter, with # being the chapter number, see [[Adding chapters to your mod]].
|-
|-
| '''game.cfg''' || Ran every time a map is loaded.
| '''game.vcfg''' || Ran every time a map is loaded.
|-
|-
| '''sourcevr_modfoldername.cfg''' || {{src13|since}} Ran when the player enables VR, replace modfoldername with the name of your folder that [[gameinfo.txt]] is in.
| '''sourcevr_modfoldername.vcfg''' || {{src13|since}} Ran when the player enables VR, replace modfoldername with the name of your folder that [[gameinfo.txt]] is in.
|-
|-
| '''skill_manifest.cfg''' || Runs every time the map is changed, used to list the skill.cfgs to execute.
| '''skill_manifest.vcfg''' || Runs every time the map is changed, used to list the skill.cfgs to execute.
|-
|-
| '''360controller.cfg''' || Used for players using {{360|4}} controllers, lists the controls for the controller. Automatically executed when player enable Gamepad support in game options.
| '''360controller.vcfg''' || Used for players using {{360|4}} controllers, lists the controls for the controller. Automatically executed when player enable Gamepad support in game options.
|-
|-
| '''360controller-linux.cfg''' || Used for players using {{360|4}} controllers on Linux systems, lists the controls for the controller. {{confirm|executed after 360controller.cfg.}}
| '''360controller-linux.vcfg''' || Used for players using {{360|4}} controllers on Linux systems, lists the controls for the controller. {{confirm|executed after 360controller.cfg.}}
|-
|-
| '''undo360controller.cfg''' || Used for players using {{360|4}} controllers when they want to undo the effects of the controller. {{todo|Find out when this is executed.}}
| '''undo360controller.vcfg''' || Used for players using {{360|4}} controllers when they want to undo the effects of the controller. {{todo|Find out when this is executed.}}
|-
|-
| '''listenserver.cfg''' || Ran when a listen server is being started, and runs every time the map is changed.
| '''listenserver.vcfg''' || Ran when a listen server is being started, and runs every time the map is changed.
|-
|-
| '''server.cfg''' || Ran when a dedicated server is being started, and runs every time the map is changed.
| '''server.vcfg''' || Ran when a dedicated server is being started, and runs every time the map is changed.
|-
|-
| '''[[valve.rc]]''' || Special cfg file with the .rc extension, it's ran on game start up and executes autoexec.cfg along with a few other commands.
| '''[[valve.rc]]''' || Special vcfg file with the .rc extension, it's ran on game start up and executes autoexec.cfg along with a few other commands.
|-
|-
|}
|}
==See also==
* [[Mini-mod tutorial]]
* [[vtest]] - Alternative to cfg files.
* {{Command|alias}}
* {{Command|echo}}

Revision as of 10:06, 13 September 2023

Valve Configuration file (or VCFG) is a Source 2 Source 2 games text file used to execute a newline-delimited list of console commands to the Developer Console. The .cfg file extension can be found everywhere and is not specific to Source.

Template:ModernTip

Confirm:What exactly happens after exec autoexec.cfg.

File format

  • Each line is considered a command. Note that each command can still consist of multiple commands delimited with the semicolon ;.
  • Comments can be added by using //. These two characters and everything following after them is ignored by the engine until the next line starts.
  • Cheat commands require sv_cheats 1 enabled, otherwise they have no effect. To configure a mod's default cheat convars, VScript or point_servercommand can achieve this on map start without having to enable sv_cheats.

Files

The folder <game>/cfg/ is usually dedicated to CFG files and can be further organized in subdirectories, and referred in exec by relative path.

This is a table listing common CFG files found in mods and games alike.

CFG Description
autoexec.vcfg Ran on game start up, so one can easily create the file and put any commands that one doesn't want to type each time.
modsettings.vcfg Ran on game start up, unless not found in mod folder.
config.cfg Ran on game start up, this is created automatically when the player runs the game/mod for the first time.
Note.pngNote: On game quit, key binds in this file will be re-written to current bindings, so making changes to this file is most likely pointless.
config_default.vcfg Ran when no config.cfg is present or when player clicks the 'Use Defaults' button in the keyboard tab in the options panel, see Customizing Options: Keyboard.
chapter#.vcfg Ran when the player picks the chapter, with # being the chapter number, see Adding chapters to your mod.
game.vcfg Ran every time a map is loaded.
sourcevr_modfoldername.vcfg (in all games since Source 2013) Ran when the player enables VR, replace modfoldername with the name of your folder that gameinfo.txt is in.
skill_manifest.vcfg Runs every time the map is changed, used to list the skill.cfgs to execute.
360controller.vcfg Used for players using Xbox 360 Xbox 360 controllers, lists the controls for the controller. Automatically executed when player enable Gamepad support in game options.
360controller-linux.vcfg Used for players using Xbox 360 Xbox 360 controllers on Linux systems, lists the controls for the controller.
Confirm:executed after 360controller.cfg.
undo360controller.vcfg Used for players using Xbox 360 Xbox 360 controllers when they want to undo the effects of the controller.
Todo: Find out when this is executed.
listenserver.vcfg Ran when a listen server is being started, and runs every time the map is changed.
server.vcfg Ran when a dedicated server is being started, and runs every time the map is changed.
valve.rc Special vcfg file with the .rc extension, it's ran on game start up and executes autoexec.cfg along with a few other commands.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=VCFG&oldid=346434"