Difference between revisions of "Config File"

From BZFlagWiki
Jump to: navigation, search
(add category, formatting, remove {{{'s and }}}'s)
(Location: update)
 
(31 intermediate revisions by 18 users not shown)
Line 1: Line 1:
BZFlag uses a [[Config File]] to store user settings.
+
BZFlag uses an ASCII configuration file to store user settings. The file is called "config.cfg."
 +
==Location==
 +
The location of the config file depends on your operating system.
  
= Windows =
+
===Windows BZFlag 2.4===
 +
'''XP''': C:\Documents and Settings\[user]\Local Settings\Application Data\BZFlag\2.4\config.cfg<br />
 +
'''Vista / 7''': C:\Users\[user]\AppData\Local\BZFlag\2.4\config.cfg<br /><br />
 +
An easy way to get to the BZFlag config folder is to do '''windows key + r''' then copy/paste '''%LOCALAPPDATA%\BZFlag''' into the box and hit enter.<br />
  
My Documents\My BZFlag Files\2.0\config.cfg
+
(You will need to replace [user] with whichever Windows user name you are currently logged in as.)
  
= Mac OS X =
+
===Mac OS X===
  
~/Library/Application Support/BZFlag/2.0/config.cfg
+
~/Library/Application Support/BZFlag/2.4/config.cfg
  
= Linux and unix platforms =
+
===Linux and unix platforms===
  
~/.bzf/2.0/config.cfg
+
~/.bzf/2.4/config.cfg
 +
 
 +
Note: "~" is expanded to your home directory
 +
 
 +
==Editing the Config File==
 +
As the config file is a text file, it is possible to directly edit it via text-editor instead of through the built-in GUI. Most things can be edited through the in-game GUI, however, there are some things that you can only add via text-editor. Settings that can only be set by editing the config file directly will be discussed here. (Note: these can also be set in-game with the /localset or /bind commands).
 +
 
 +
===Localset Options===
 +
  set highlightPattern "laser"
 +
  set highlightPattern "laser|genocide"
 +
  set highlightPattern "(Team Flag|Team's Flag|Genocide)"
 +
''highlightPattern'' highlights lines with the selected words when they appear in the console(chat box).
 +
*When highlighting one word, just type the word in quotes, such as "laser."
 +
*If one wants to highlight two or more words, the words must be separated with a '|', such as "laser|genocide" (highlights lines with laser OR genocide).
 +
*If any of the words have spaces, all the words must be surrounded in parentheses, such as "(Team Flag|Team's Flag|Genocide)" (highlights lines with "Team Flag," "Team's Flag," OR "Genocide").
 +
 
 +
 
 +
  set linedradarshots 10
 +
  set linedradarshots 65
 +
''linedradarshots'' sets how long shots are on the radar. While this option ''is'' set-able through the in-game GUI, you can only set this setting up to 10 via the GUI. You can hand-edit your config to give you longer shot lengths.
 +
 
 +
 
 +
  set latitude 45
 +
  set longitude 71
 +
''latitude'' and ''longitude'' set the latitude and longitude for BZFlag's sky rendering system.
 +
 
 +
''Hint: To always have a black sky set latitude 90 (north pole) or -90 (south pole) for winter/summer respectively.''
 +
 
 +
===Binding Custom Keys===
 +
One can bind custom keys outside of those given in the in-game GUI.
 +
 
 +
The standard format for binding a key is as follows:
 +
  bind <event> <press> <action>
 +
 
 +
The event is the key or button that was pressed (or a combination of keys) such as F or "Shift+Page Up". The double quotes are necessary if there are spaces. The press will be one of up, down, or both. If it is set to up, for example, if will only trigger when they key or button is released. And finally, the action is what will be triggered.
 +
 
 +
For example, the following binding sets ''displayRadarRange'', or how far the radar is zoomed, to 0.12, when the key '`' is pressed.
 +
  bind ` down "set displayRadarRange 0.12"
 +
 
 +
One can use this template to set any of the options in the config file. However, some of the options, like ''radarsize'' need an additional function call that is only called via the options menu, and as such cannot be altered with this method.
 +
 
 +
 
 +
One can also use the toggle keyword instead of set to have a key toggle two options:
 +
  bind F down "toggle linedradarshots 65"
 +
  bind F down "toggle linedradarshots 65 10"
 +
The first line toggles the length of shots on the radar between 65 and an implied 0. The second line toggles ''linedradarshots'' between 65 and 10. This is much easier than having two keys to switch between two options.
 +
 
 +
''(Don't do this.)''
 +
  bind F down "set linedradarshots 65"
 +
  bind G down "set linedradarshots 10"
 +
 
 +
You can also bind one key with two funtions:
 +
 
 +
bind E down fire
 +
bind E up identify
 +
 
 +
This will make it so you can fire and lock-on with GM with the same button.
 +
 
 +
To un-bind a key, just place a hash(#) at the front of the line, or remove the line completely. For example, to if one is tired of unintentionally hitting F12, he or she can simply disable it.
 +
  #bind F12 down quit
 +
<!--
 +
 
 +
Sample Config file to reference, if you want to expand further.
 +
 
 +
 
 +
set activeInputDevice Keyboard
 +
#set allowInputChange 1
 +
set alwaysShowTeamScores 1
 +
#set animatedTreads 1
 +
#set aniso 1
 +
#set baseTopTexture basetop
 +
#set baseWallTexture basewall
 +
set blend 1
 +
#set blueTeamPrefix blue_
 +
#set boltTexture bolt
 +
#set boxTopTexture roof
 +
#set boxWallHighResTexRepeat 5.0
 +
#set boxWallTexRepeat 1.5
 +
#set boxWallTexture boxwall
 +
set callsign me1
 +
#set cautionTexture caution
 +
#set coloredradarshots 1
 +
#set colorful 1
 +
set config_version 3
 +
#set consoleFont VeraMonoBold
 +
set cpanelfontsize 1
 +
#set deathEffect 1
 +
set displayFlagHelp 0
 +
set displayLabels 0
 +
#set displayReloadTimer 1
 +
#set displayScore 1
 +
#set displayZoom 1
 +
set dither 1
 +
#set doDownloads 1
 +
set email ""
 +
set emailDispLen 128
 +
#set enableLocalShotEffect 0
 +
#set enableLocalSpawnEffect 1
 +
#set f2bsort 1
 +
set flagChunks 32
 +
#set flagLists 0
 +
set fogEffect 2
 +
#set fpsLimit 30
 +
set gamma 1.000000
 +
set geometry 800x600
 +
#set gmPuffEffect 2
 +
#set gmPuffTime 1/8
 +
#set greenTeamPrefix green_
 +
#set groundHighResTexRepeat 0.05
 +
#set groundTexRepeat 0.1
 +
#set hideEmails 0
 +
set highlightPattern "(Team Flag|Team's Flag|Genocide)"
 +
#set httpTimeout 15
 +
#set hudGUIBorderOpacityFactor 0.75
 +
#set hunterTeamPrefix hunter_
 +
set jumpTyping 0
 +
#set killerhighlight 1
 +
#set landEffect 1
 +
#set laserTexture laser
 +
set lastScreenshot 185
 +
set latitude 45
 +
set leadingShotLine 1
 +
#set lightLists 0
 +
set lighting 1
 +
set linedradarshots 10
 +
#set list http://my.BZFlag.org/db/
 +
#set listIcons 1
 +
#set lodScale 1.0
 +
set longitude 71
 +
#set maxCacheMB 32
 +
#set maxTextureSize 512
 +
#set meshLists 1
 +
set moonSegments 64
 +
#set motdServer http://bzflag.org/motd.php
 +
set mouseboxsize 4
 +
set mousegrab true
 +
set noGUI 0
 +
#set noMeshClusters 0
 +
#set observerTeamPrefix observer_
 +
set panelopacity 0.000000
 +
set password nopasswordforyou
 +
set port 4410
 +
set pulseDepth 0.900000
 +
set pulseRate 1.800000
 +
#set purpleTeamPrefix purple_
 +
#set pyrWallHighResTexRepeat 8.0
 +
#set pyrWallTexRepeat 3.0
 +
#set pyrWallTexture pyrwall
 +
set quality experimental
 +
#set rabbitTeamPrefix rabbit_
 +
#set radarLodScale 1.0
 +
set radarStyle 2
 +
#set radarTankPixels 2.0
 +
set radarsize 15
 +
#set redTeamPrefix red_
 +
#set remoteSounds 1
 +
set resolution "1280x1024 @75Hz 32 bits"
 +
#set ricoEffect 1
 +
#set roamSmoothTime 0.5
 +
#set rogueTeamPrefix rogue_
 +
#set sansSerifFont TogaSansBold
 +
set saveAsMeshes 0
 +
set saveAsOBJ 0
 +
set saveEnergy 1
 +
set saveFlatFile 0
 +
#set saveIdentity 2
 +
#set saveSettings 1
 +
set scoreboardSort 1
 +
set scorefontsize 1
 +
#set scrollPages 20
 +
#set serifFont TogaSerifBold
 +
set server bzflag2.norang.ca
 +
#set serverCacheAge 0
 +
#set shadowAlpha 0.5
 +
set shadows 1
 +
#set shotEffect 1
 +
#set showCollisionGrid 0
 +
set showCoordinates 1
 +
#set showCullingGrid 0
 +
#set showTreads 0
 +
set showVelocities 3
 +
set showtabs 0
 +
set sizedradarshots 4
 +
set smooth 1
 +
#set spawnEffect 1
 +
set startcode bfaaaaabaaaaa
 +
#set stdGroundTexture std_ground
 +
#set stencilShadows 0
 +
#set superPrefix super_
 +
#set tankTexture tank
 +
set team Automatic
 +
set tesselation 1
 +
set texture linearmipmaplinear
 +
set timedate 2
 +
set tkwarnratio .4
 +
#set tpEffect 1
 +
#set trackMarkCulling 3
 +
set treadStyle 0
 +
#set udpnet 1
 +
set underlineColor Cyan
 +
set updateDownloads 1
 +
#set useDrawInfo 1
 +
#set useFancyEffects 1
 +
#set useMeshForRadar 0
 +
set useQuality 3
 +
#set useVelOnShotEffects 1
 +
#set userMirror 1
 +
set userRainScale 1.000000
 +
set userTrackFade 1.000000
 +
set volume 7
 +
#set waterTexture water
 +
set worldCacheLimit 10485760
 +
#set zbuffer 1
 +
#set zoneGroundTexture zone_ground
 +
bind Pause down pause
 +
bind End down "scrollpanel bottom"
 +
bind "Left Arrow" down "turn left"
 +
bind "Right Arrow" down "turn right"
 +
bind "Up Arrow" down "drive forward"
 +
bind "Down Arrow" down "drive reverse"
 +
bind "Page Up" down "scrollpanel up_page"
 +
bind "Page Down" down "scrollpanel down_page"
 +
bind Delete down destruct
 +
bind F1 down fullscreen
 +
bind Shift+F1 down "messagepanel all"
 +
bind Shift+F2 down "messagepanel chat"
 +
bind Shift+F3 down "messagepanel server"
 +
bind F4 down iconify
 +
bind Shift+F4 down "messagepanel misc"
 +
bind F5 down screenshot
 +
bind F6 down "roam cycle subject backward"
 +
bind F7 down "roam cycle subject forward"
 +
bind F8 down "roam cycle type forward"
 +
bind F9 down "roam zoom in"
 +
bind F10 down "roam zoom out"
 +
bind F11 down "roam zoom normal"
 +
bind F12 down quit
 +
bind "Left Mouse" down fire
 +
bind "Middle Mouse" down drop
 +
bind "Right Mouse" down identify
 +
bind "Wheel Up" down fire
 +
bind "Shift+Wheel Up" down "radarZoom in"
 +
bind "Ctrl+Wheel Up" down "viewZoom in"
 +
bind "Wheel Down" down "scrollpanel down 3"
 +
bind "Shift+Wheel Down" down "radarZoom out"
 +
bind "Ctrl+Wheel Down" down "viewZoom out"
 +
bind Tab down jump
 +
bind , down "send nemesis"
 +
bind - down "time backward"
 +
bind . down "send recipient"
 +
bind 1 down "set displayRadarRange 0.25"
 +
bind 2 down "set displayRadarRange 0.5"
 +
bind 3 down "set displayRadarRange 1.0"
 +
bind 4 down "radarZoom in"
 +
bind 5 down "radarZoom out"
 +
bind 7 down addhunt
 +
bind 9 down autopilot
 +
bind = down "time forward"
 +
bind A down "toggle slowKeyboard"
 +
bind B down "viewZoom toggle"
 +
bind E down "toggle noGUI"
 +
bind F down "toggle linedradarshots 65 10"
 +
bind H down "toggleFlags radar"
 +
bind I down identify
 +
bind J down "toggleFlags main"
 +
bind K down silence
 +
bind L down "toggle displayLabels"
 +
bind M down "send team"
 +
bind N down "send all"
 +
bind O down servercommand
 +
bind P down pause
 +
bind Q down toggleRadar
 +
bind S down "toggle displayScore"
 +
bind U down hunt
 +
bind W down toggleConsole
 +
bind Z down "send admin"
 +
bind ` down "set displayRadarRange 0.12"
 +
bind "Left Arrow" up "turn left"
 +
bind "Right Arrow" up "turn right"
 +
bind "Up Arrow" up "drive forward"
 +
bind "Down Arrow" up "drive reverse"
 +
bind F9 up "roam zoom in"
 +
bind F10 up "roam zoom out"
 +
bind F11 up "roam zoom normal"
 +
bind "Left Mouse" up fire
 +
bind "Right Mouse" up restart
 +
bind "Wheel Up" up fire
 +
bind Tab up jump
 +
bind I up restart
 +
-->
 +
==Key Mapping==
 +
 
 +
Below is a list of the default key mappings within the [[BZFlag]] client. These can be changed in Options -> Input Settings -> Key Mapping.
 +
 
 +
{|{{Prettytable}}
 +
|-
 +
| {{Hl3}} |'''Key(s)'''
 +
| {{Hl3}} |'''Description'''
 +
|-
 +
|- - || time backward
 +
|-
 +
| 1 || set displayRadarRange 0.25
 +
|-
 +
| 2 || set displayRadarRange 0.5
 +
|-
 +
| 3 || set displayRadarRange 1.0
 +
|-
 +
| 4 || radarZoom in
 +
|-
 +
| 5 || radarZoom out
 +
|-
 +
| 7 || addhunt
 +
|-
 +
| 9 || autopilot
 +
|-
 +
| = || time forward
 +
|-
 +
| A || toggle slowKeyboard
 +
|-
 +
| B || viewZoom toggle
 +
|-
 +
| F || toggle displayFlagHelp
 +
|-
 +
| H || toggleFlags radar
 +
|-
 +
| I || restart
 +
|-
 +
| J || toggleFlags main
 +
|-
 +
| K || silence
 +
|-
 +
| O || servercommand
 +
|-
 +
| P || pause
 +
|-
 +
| Q || toggleRadar
 +
|-
 +
| S || toggle displayScore
 +
|-
 +
| T || toggle frames-per-second display
 +
|-
 +
| U || hunt
 +
|-
 +
| W || toggleConsole
 +
|-
 +
| Y || toggle milliseconds for frame-drawing [added by hand]
 +
|-
 +
| F1 || fullscreen
 +
|-
 +
| F4 || iconify
 +
|-
 +
| F5 || screenshot
 +
|-
 +
| End || scrollpanel bottom
 +
|-
 +
| F12 || quit
 +
|-
 +
| Tab || jump
 +
|-
 +
| Enter || fire
 +
|-
 +
| Pause || pause
 +
|-
 +
| Space || drop flag
 +
|-
 +
| Delete || self-destruct
 +
|-
 +
| Ctrl+Wheel Down || viewZoom out
 +
|-
 +
| Ctrl+Wheel Up || viewZoom in
 +
|-
 +
| Home (Pos1) || get shots statistic for players [added by hand]
 +
|-
 +
| Mouse Left || fire
 +
|-
 +
| Mouse Middle || drop
 +
|-
 +
| Mouse Right || restart
 +
|-
 +
| Page Down || scrollpanel down_page
 +
|-
 +
|Page Up || scrollpanel up_page
 +
|-
 +
| Shift+F1 || messagepanel all
 +
|-
 +
| Shift+F2 || messagepanel chat
 +
|-
 +
| Shift+F3 || messagepanel server
 +
|-
 +
| Shift+F4 || messagepanel misc
 +
|-
 +
| Shift+Wheel Down || radarZoom out
 +
|-
 +
| Shift+Wheel Up || radarZoom in
 +
|-
 +
| Wheel Down || scrollpanel down 3
 +
|-
 +
| Wheel Up || scrollpanel up 3
 +
|-
 +
| Arrow Down || Drive backwards
 +
|-
 +
| Arrow Up || Drive forwards
 +
|-
 +
| Arrow Left || Turn left
 +
|-
 +
| Arrow Right || Turn right
 +
|-
 +
| , || Send PM to nemesis
 +
|-
 +
| . || Send PM to recipient
 +
|-
 +
| M || Send a message to your team
 +
|-
 +
| N || Send a message to all players
 +
|-
 +
| Z || Send a message to admins.
 +
|-
 +
| ALT+(F1-F10) || Custom [[quick keys]] to all.
 +
|-
 +
| CTRL+(F1-F10) || Custom quick keys to team.
 +
|-
 +
| L || Toggle display labels in observer
 +
|-
 +
| F6 || roam cycle subject backward
 +
|-
 +
| F7 || roam cycle subject forwards
 +
|-
 +
| F8 || change observer mode
 +
|-
 +
| F9 || zoom in
 +
|-
 +
| F10 || zoom out
 +
|-
 +
| F11 || normal zoom
 +
|-
 +
| ALT+Arrow Keys || move forward and backward, and strafe left and right while roaming
 +
|-
 +
| CTRL+Arrow Keys || rotate left, right, up and down while roaming
 +
|-
 +
| SHIFT+Arrow Keys || move up and down while roaming (up/down are reversed)
 +
|-
 +
 
 +
|}
 +
 
 +
==See Also==
 +
* [[Content Restrictions]]
  
 
[[Category:Client]]
 
[[Category:Client]]

Latest revision as of 20:08, 27 February 2017

BZFlag uses an ASCII configuration file to store user settings. The file is called "config.cfg."

Location[edit]

The location of the config file depends on your operating system.

Windows BZFlag 2.4[edit]

XP: C:\Documents and Settings\[user]\Local Settings\Application Data\BZFlag\2.4\config.cfg
Vista / 7: C:\Users\[user]\AppData\Local\BZFlag\2.4\config.cfg

An easy way to get to the BZFlag config folder is to do windows key + r then copy/paste %LOCALAPPDATA%\BZFlag into the box and hit enter.

(You will need to replace [user] with whichever Windows user name you are currently logged in as.)

Mac OS X[edit]

~/Library/Application Support/BZFlag/2.4/config.cfg

Linux and unix platforms[edit]

~/.bzf/2.4/config.cfg

Note: "~" is expanded to your home directory

Editing the Config File[edit]

As the config file is a text file, it is possible to directly edit it via text-editor instead of through the built-in GUI. Most things can be edited through the in-game GUI, however, there are some things that you can only add via text-editor. Settings that can only be set by editing the config file directly will be discussed here. (Note: these can also be set in-game with the /localset or /bind commands).

Localset Options[edit]

 set highlightPattern "laser"
 set highlightPattern "laser|genocide"
 set highlightPattern "(Team Flag|Team's Flag|Genocide)"

highlightPattern highlights lines with the selected words when they appear in the console(chat box).

  • When highlighting one word, just type the word in quotes, such as "laser."
  • If one wants to highlight two or more words, the words must be separated with a '|', such as "laser|genocide" (highlights lines with laser OR genocide).
  • If any of the words have spaces, all the words must be surrounded in parentheses, such as "(Team Flag|Team's Flag|Genocide)" (highlights lines with "Team Flag," "Team's Flag," OR "Genocide").


 set linedradarshots 10
 set linedradarshots 65

linedradarshots sets how long shots are on the radar. While this option is set-able through the in-game GUI, you can only set this setting up to 10 via the GUI. You can hand-edit your config to give you longer shot lengths.


 set latitude 45
 set longitude 71

latitude and longitude set the latitude and longitude for BZFlag's sky rendering system.

Hint: To always have a black sky set latitude 90 (north pole) or -90 (south pole) for winter/summer respectively.

Binding Custom Keys[edit]

One can bind custom keys outside of those given in the in-game GUI.

The standard format for binding a key is as follows:

 bind <event> <press> <action>

The event is the key or button that was pressed (or a combination of keys) such as F or "Shift+Page Up". The double quotes are necessary if there are spaces. The press will be one of up, down, or both. If it is set to up, for example, if will only trigger when they key or button is released. And finally, the action is what will be triggered.

For example, the following binding sets displayRadarRange, or how far the radar is zoomed, to 0.12, when the key '`' is pressed.

 bind ` down "set displayRadarRange 0.12"

One can use this template to set any of the options in the config file. However, some of the options, like radarsize need an additional function call that is only called via the options menu, and as such cannot be altered with this method.


One can also use the toggle keyword instead of set to have a key toggle two options:

 bind F down "toggle linedradarshots 65"
 bind F down "toggle linedradarshots 65 10"

The first line toggles the length of shots on the radar between 65 and an implied 0. The second line toggles linedradarshots between 65 and 10. This is much easier than having two keys to switch between two options.

(Don't do this.)

 bind F down "set linedradarshots 65"
 bind G down "set linedradarshots 10"

You can also bind one key with two funtions:

bind E down fire
bind E up identify

This will make it so you can fire and lock-on with GM with the same button.

To un-bind a key, just place a hash(#) at the front of the line, or remove the line completely. For example, to if one is tired of unintentionally hitting F12, he or she can simply disable it.

 #bind F12 down quit

Key Mapping[edit]

Below is a list of the default key mappings within the BZFlag client. These can be changed in Options -> Input Settings -> Key Mapping.

Key(s) Description
1 set displayRadarRange 0.25
2 set displayRadarRange 0.5
3 set displayRadarRange 1.0
4 radarZoom in
5 radarZoom out
7 addhunt
9 autopilot
= time forward
A toggle slowKeyboard
B viewZoom toggle
F toggle displayFlagHelp
H toggleFlags radar
I restart
J toggleFlags main
K silence
O servercommand
P pause
Q toggleRadar
S toggle displayScore
T toggle frames-per-second display
U hunt
W toggleConsole
Y toggle milliseconds for frame-drawing [added by hand]
F1 fullscreen
F4 iconify
F5 screenshot
End scrollpanel bottom
F12 quit
Tab jump
Enter fire
Pause pause
Space drop flag
Delete self-destruct
Ctrl+Wheel Down viewZoom out
Ctrl+Wheel Up viewZoom in
Home (Pos1) get shots statistic for players [added by hand]
Mouse Left fire
Mouse Middle drop
Mouse Right restart
Page Down scrollpanel down_page
Page Up scrollpanel up_page
Shift+F1 messagepanel all
Shift+F2 messagepanel chat
Shift+F3 messagepanel server
Shift+F4 messagepanel misc
Shift+Wheel Down radarZoom out
Shift+Wheel Up radarZoom in
Wheel Down scrollpanel down 3
Wheel Up scrollpanel up 3
Arrow Down Drive backwards
Arrow Up Drive forwards
Arrow Left Turn left
Arrow Right Turn right
, Send PM to nemesis
. Send PM to recipient
M Send a message to your team
N Send a message to all players
Z Send a message to admins.
ALT+(F1-F10) Custom quick keys to all.
CTRL+(F1-F10) Custom quick keys to team.
L Toggle display labels in observer
F6 roam cycle subject backward
F7 roam cycle subject forwards
F8 change observer mode
F9 zoom in
F10 zoom out
F11 normal zoom
ALT+Arrow Keys move forward and backward, and strafe left and right while roaming
CTRL+Arrow Keys rotate left, right, up and down while roaming
SHIFT+Arrow Keys move up and down while roaming (up/down are reversed)

See Also[edit]