CFG: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (added a note: if the game is naturally quit (so, not crashed) the player's keybindings will overwrite the binds in the config file (if you used a navmesh keybind before closing the game, you will have it on next launch) (it was painful finding out :( ))
(serious clean up)
Line 1: Line 1:
{{lang|CFG}}
{{lang|CFG}}
'''.cfg''' files can be found everywhere and are not specific to [[Source]]. It is an abbreviation of ''configuration''.
The '''.cfg''' file extension can be found everywhere and is not specific to [[Source]]. It is an abbreviation of ''configuration''. In [[Source]] games, a configuration file executes a list of [[console command | console commands]].


Source games usually have a folder dedicated to CFG files. Inside, the file <code>autoexec.cfg</code> is run when the game starts up, so you can easily put any commands that you don't want to enter each time into that. They can also be ran from the console using the {{ent|exec}} command: "<code>exec <cfgname></code>" where filename is the name of the configuration file, with or without the extension. Sometimes people put exec lines into the [[autoexec]], so that other CFG files are executed when the game starts up.


In Source games, a configuration file can be executed to perform a list of console commands. CFG files can be written in any other plain [[text editor]]. To create one, right-click the blank space in a cfg folder, and go to <code>New>Text file</code>. Rename it to <code>myconfig.cfg</code> or whatever you want, as long as it ends in .cfg and is placed in the cfg folder. You can then open it in your text editor and put commands in.  Normally, the file <code>autoexec.cfg</code> is run when the game starts up, so you can easily put any commands that you don't want to enter each time into that.  They can also be ran from the console using "<code>exec <cfgname></code>" where filename is the name of the configuration file, with or without the extension. Sometimes people put exec lines into the <code>autoexec.cfg</code>, so that other cfg files are executed when the game starts up. Configuration files can be placed in subdirectories of the cfg folder. The exec command would require you to include the subdirectories in the command.
CFG files can be further organized in subdirectories in the CFG folder, and referred to by [https://en.wikipedia.org/relative_path relative path].


{{tip|You can add comments to .cfg files by using // .}}
{{tip|You can add comments to .cfg files by using // .}}

Revision as of 16:37, 22 October 2021

English (en)Deutsch (de)Translate (Translate)

The .cfg file extension can be found everywhere and is not specific to Source. It is an abbreviation of configuration. In Source games, a configuration file executes a list of console commands.

Source games usually have a folder dedicated to CFG files. Inside, the file autoexec.cfg is run when the game starts up, so you can easily put any commands that you don't want to enter each time into that. They can also be ran from the console using the exec command: "exec <cfgname>" where filename is the name of the configuration file, with or without the extension. Sometimes people put exec lines into the autoexec, so that other CFG files are executed when the game starts up.

CFG files can be further organized in subdirectories in the CFG folder, and referred to by relative path.

Tip.pngTip:You can add comments to .cfg files by using // .
Note.pngNote:Cheat commands sv_cheats 1 enabled. To configure a mod's default cheat convars, VScript or point_servercommand can achieve this on map start without having to enable sv_cheats

Common CFGs

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

CFG Description
autoexec.cfg Ran on game start up.
modsettings.cfg 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.
config_default.cfg Ran when no config.cfg is present or the 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.
game.cfg Ran every time a map is loaded.
sourcevr_modfoldername.cfg Template:2013 add 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.
360controller.cfg Used for players using XBox 360 controllers, lists the controls for the controller.
Todo: Find out when this is executed.
360controller-linux.cfg Used for players using XBox 360 controllers on Linux systems, lists the controls for the controller.
Confirm:executed after 360controller.cfg.
undo360controller.cfg Used for players using XBox 360 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.
server.cfg 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.

See also

External links

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=CFG&oldid=250028"