.cfg: Difference between revisions

From Jedi Knight Wiki | JKHub
(Created page with "The .cfg file type which stands for Context-free grammar is one of the files used to get the game to know when to use certain codes or command to make things work. Most player...")
 
No edit summary
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The .cfg file type which stands for Context-free grammar is one of the files used to get the game to know when to use certain codes or command to make things work.
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.
Most players customize there own .cfg files so they don't have to while in game.
 
== 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
 
{| class="wikitable"
|-
| [insert any commands/cvars]<br />[on a new line, add the next command/cvar modification]
|}
 
The finished .cfg file can then be placed in [[PK3|.pk3]] file, or the [[Base Folder|base folder]].
 
== Execution ==
In order to execute a configuration file, type the following into the [[console]]:
 
{| class="wikitable"
|-
| 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 [[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.
* Any cvar changed using [[Cvar|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
 
[[category:File Types]]

Latest revision as of 09:10, 5 May 2020

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[edit]

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[edit]

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[edit]

  • 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[edit]

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