.cfg: Difference between revisions

From Jedi Knight Wiki | JKHub
m (MUG moved page .CFG file to .CFG File)
(wording, grammar)
Line 1: Line 1:
A '''CFG''', or '''configuration file''', is a .cfg document that allows the player to group a list of [[command|commands]], or change numerous [[cvar|cvars]] simultaneously. [[the game|The game]] automatically saves your settings to a config file which is automatically loaded when the game starts
A '''CFG''', or '''configuration file''', is a .cfg document that allows the player to group a list of [[command|commands]], or change numerous [[cvar|cvars]] simultaneously. [[the game|The game]] automatically saves your settings to a config file which is automatically loaded when the game starts.


== Format ==
== Format ==
Generically, a .cfg file is a regular text file, renamed to have the extension ".cfg", however, this is not required. The text file is then modified and filled with content, like so
A .cfg file is a regular text file, usually renamed to have the extension ".cfg", although this is not required. The text file is then modified and filled with content, like so


{| class="wikitable"
{| class="wikitable"
Line 16: Line 16:
{| class="wikitable"
{| class="wikitable"
|-
|-
| exec [cfg name (no '.cfg' is required]
| exec [cfg name (no '.cfg' is required)]
|}
|}


Line 25: Line 25:
* 'default.cfg' and 'mpdefault.cfg' are used in [[JKA]] to set the [[bind|binds]] for the game.
* 'default.cfg' and 'mpdefault.cfg' are used in [[JKA]] to set the [[bind|binds]] for the game.
* In JKA, 'JASP.cfg' and 'JAMP.cfg' are created when the respective game is played, and they store the session's information there.
* In JKA, 'JASP.cfg' and 'JAMP.cfg' are created when the respective game is played, and they store the session's information there.
* The player can use [[Cvar|seta]] to modify cvars. This makes the modification saved to any written .cfg files.
* Any cvar changed using [[Cvar|seta]] gets saved to .cfg files.


== Related Commands ==
== Related Commands ==
* The [[write]] command writes a .cfg file
* The [[write]] command writes a .cfg file
* The [[exec]] command (mentioned above) executes a desired .cfg file
* The [[exec]] command (mentioned above) executes a given .cfg file


[[category:File Types]]
[[category:File Types]]
[[category:Needs Expansion]]
[[category:Needs Expansion]]

Revision as of 17:46, 2 December 2013

A CFG, or configuration file, is a .cfg document that allows the player to group a list of commands, or change numerous cvars simultaneously. The game automatically saves your settings to a config file which is automatically loaded when the game starts.

Format

A .cfg file is a regular text file, usually renamed to have the extension ".cfg", although this is not required. The text file is then modified and filled with content, like so

[insert any commands/cvars]
[on a new line, add the next command/cvar modification]

The finished .cfg file can then be placed in .pk3 file, or the base folder.

Execution

In order to execute a configuration file, type the following into the console:

exec [cfg name (no '.cfg' is required)]

However, if you decided to create a configuration with another extensions, like .txt, then you must include the '.txt' in the cfg name.

Special Configuration Files

  • A configuration file titled 'autoexec.cfg' is automatically executed on game start.
  • 'default.cfg' and 'mpdefault.cfg' are used in JKA to set the binds for the game.
  • In JKA, 'JASP.cfg' and 'JAMP.cfg' are created when the respective game is played, and they store the session's information there.
  • Any cvar changed using seta gets saved to .cfg files.

Related Commands

  • The write command writes a .cfg file
  • The exec command (mentioned above) executes a given .cfg file