CFG: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
(Rearranged first paragraph. Moved some of it to a Sytax section.)
Line 1: Line 1:
{{lang|CFG}}
{{lang|CFG}}
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]].
In {{game name|src|name=Source}} games, a '''configuration file''', or '''CFG''', is a text file used to execute a newline-delimited list of [[console command]]s to the [[Developer Console]]. The '''.cfg''' file extension can be found everywhere and is not specific to Source.


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.
The folder <code><game>/cfg/</code> is usually dedicated to CFG files and can be further organized in subdirectories, and referred in {{ent|exec}} by [[W:Path_(computing)#Absolute_and_relative_paths|relative path]].


CFG files can be further organized in subdirectories in the CFG folder, and referred in {{ent|exec}} by [https://en.wikipedia.org/relative_path relative path].
CFG files can be run from the console using the {{ent|exec}} command.


{{tip|You can add comments to .cfg files by using // .}}
{{tip|The file <code><game>/cfg/autoexec.cfg</code> is run when the game starts up if it exists, so one can easily create the file and put any commands that one doesn't want to type each time.}}
{{note|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}}
 
== Syntax ==
* Each line is considered a command. Note that each command can still consist of multiple commands delimited with the semicolon <code>;</code>.
* Comments can be added by using <code>//</code>. These two characters and everything following after them is ignored by the engine until the next line starts.
* Cheat commands require {{ent|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.


== Common CFGs ==
== Common CFGs ==
This is a table listing common .cfg files found in mods and games alike.
This is a table listing common CFG files found in mods and games alike.


{| class="wikitable"
{| class="wikitable"
Line 19: Line 23:
| '''modsettings.cfg''' || Ran on game start up, unless not found in mod folder.
| '''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| On game quit, key binds in this file will be re-written to current bindings. }}
| '''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_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]].
| '''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]].
Line 48: Line 52:
* [[Mini-mod tutorial]]
* [[Mini-mod tutorial]]
* [[vtest]] - Alternative to cfg files.
* [[vtest]] - Alternative to cfg files.
* {{ent|bind}}
* {{ent|alias}}
* {{ent|echo}}


== External links ==
== External links ==

Revision as of 20:34, 19 December 2021

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

In Template:Game name games, a configuration file, or CFG, is a 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.

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

CFG files can be run from the console using the exec command.

Tip.pngTip:The file <game>/cfg/autoexec.cfg is run when the game starts up if it exists, so one can easily create the file and put any commands that one doesn't want to type each time.

Syntax

  • 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.

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, so making changes to this file is most likely pointless.
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=251203"