# This document lists all available options that could be changed
# in the netrekrc file

agriCAPS:                 (on/off) show AGRI planet name in caps on the map
agriColor:                (0-2) select color to display agri planet names on the map
# 0 - owner race color
# 1 - white
# 2 - gray

allowWheelActions:        (on/off) allow mouse wheel to work in non-scrolling windows
autoQuit:                 (int) autoquit time after death
autoRotate:               (on/off) automatically rotate galaxy so teams are on left side of map
autoSetWar:               (0-2) declare war with enemy races when you first join
# 0 - Don't set war
# 1 - Set war with nonzero player teams, peace w/ 0 player teams
# 2 - Set war with largest enemy team,  peace w/ everyone else

b1keymap:                 (string) keymap for mouse button 1 (mouseAsShift=on)
b2keymap:                 (string) keymap for mouse button 2 (mouseAsShift=on)
b3keymap:                 (string) keymap for mouse button 3 (mouseAsShift=on)
b4keymap:                 (string) keymap for mouse button 4 (mouseAsShift=on)
b5keymap:                 (string) keymap for mouse button 5 (mouseAsShift=on)
baseUdpLocalPort:         (port) use this port as base for UDP
beepOnPrivateMessage:	  (on/off) beep if received private message
buttonmap:                (string) change mouse button map
buttonmap-<ship>:         (string) use this buttonmap for ship (sc,dd,ca,bb,as,sb,ga,att)
ckeymap:                  (string) change control keymap
ckeymap-<ship>:           (string) use this ckeymap for ship (sc,dd,ca,bb,as,sb,ga,att)
cloakChars:               (two chars) how to display cloaker on galactic
clickDelay:               (0-50) delay before continuous mouse clicks, in updates (0 = no delay)
color.God:                (color) replace God message color with (color)
color.<color>:            (color) replace first <color> with (color)
color.<race>:             (color) replace that race color with (color)
colorClient:              (0-3) what type of ship bitmaps to use
# 0 - mono
# 1 - new color bitmaps
# 2 - old color bitmaps
# 3 - shaded old color bitmaps
# 4 - experimental high res bitmaps

colorfulPhasers:          (on/off) make your phasers multicolored
colorWeapons:             (on/off) use colored bitmaps for torps and plasmas
continueTractor:          (on/off) show tractors after lock
continuousMouse:          (on/off) use continuous mouse mode
continuousMouseFix:       (on/off) fix continuous mouse behavior
detCircle:                (on/off) show det circle around your ship
disableWinkey:            (on/off) disable Windows and Context keys
documentation:            (path) path to documentation file
doubleBuffering:          (on/off) use double buffering to reduce screen flicker
dynamicBitmaps:           (on/off) allow switching of ship bitmaps in game
enemyPhasers:             (1-10) enemy phaser line width
extraAlertBorder:         (on/off) change window border on enemy approach
fedshipbmpfile:           (path) - old color bitmaps
fedship1bmpfile:          (path) - new color bitmaps
fedshipGbmpfile:          (path) - your own ship's grayscale bitmaps
fedshipTbmpfile:          (path) - shaded color bitmaps
fedshipMbmpfile:          (path) - mono bitmaps
fontSize:                 (int) - height in pixels of font, default 10
forceDisplay:             (0/3) how many colors to display
# 0 - find best available color option (default)
# 1 - 16 colors
# 2 - 256 colors
# 3 - true color

forceMono:                (on/off) outdated option, that will force display to
                                   16 colors (but only works if forceDisplay = 0).
fullBitmapRotation:       (on/off) draw old bitmap sets to 256 angles instead of 32
headingTic:               (on/off) draw a tic mark indicating your ship's direction
hideConsole:              (on/off) hide DOS console window
highlightFriendlyPhasers: (on/off) use white color for friendly phasers
ignoreCaps:               (on/off) ignore CapsLock key state
indshipbmpfile:           (path) - old color bitmaps
indship1bmpfile:          (path) - new color bitmaps
indshipGbmpfile:          (path) - your own ship's grayscale bitmaps
indshipTbmpfile:          (path) - shaded color bitmaps
indshipMbmpfile:          (path) - mono bitmaps
infoRange:                (on/off) show weapon's range boundary with large tacticals windows
keepInfo:                 (0-100) number of tenths of seconds to keep info (default 15)
keepPeace:                (on/off) stays in peace after being killed
keymap:                   (string) change keymap
keymap-<ship>:            (string) use this keymap for ship (sc,dd,ca,bb,as,sb,ga,att)
klishipbmpfile:           (path) - old color bitmaps
kliship1bmpfile:          (path) - new color bitmaps
klishipGbmpfile:          (path) - your own ship's grayscale bitmaps
klishipTbmpfile:          (path) - shaded color bitmaps
klishipMbmpfile:          (path) - mono bitmaps
lockLine:                 (on/off) draw dashed green line on map from your ship to lock target,
                                   requires showLock to be on for map
logfile:                  (path) path to logfile
logging:                  (on/off) enable logging
login:                    (string) character login
macroKey:                 (char, ESC, TAB) key to toggle macro mode
mainMaximized:            (on/off) make main window maximized on client start
mainResizeable:           (on/off) make main window + local/map windows resizeable
maxScrollLines:           (50-500) maximum number of scroll lines in a message window
mainTitleBar:             (on/off) start main window with title bar on (can be toggled by alt-enter)
messageHoldThresh:        (integer) put message on hold after mouse move (Adds # to the end of message)
messageHUD:               (0-2) where to duplicate message that is written in message window
# 0 - none (default)
# 1 - tactical top
# 2 - tactical bottom

messageKeyOnly:           (on/off) only start messages with the actual message key(s),
                                   if cursor is in the message windows
messageKeyOnly: 1
metaCache:                (path) path to metacache file
metaPing:                 (on/off) show ping stats to all servers in metaserver window
metaPort:                 (port) metaserver port
metaServer:               (address) metaserver address
metaStatusLevel:          (0-4) what servers to display
# 0 - servers with players, but not on a wait queue
# 1 - servers with players and with a wait queue
# 2 - servers with nobody playing (default)
# 3 - servers timed out to metaserver
# 4 - servers that metaServer could not contact

metaType:                 (1-3) what type of metaserver to use
# 1 - UDP multiple metaservers
# 2 - cache, then TCP metaserver
# 3 - TCP metaserver, then cache

metaUDPCache:             (filename) name of UDP metacache file
metaVerbose:              (on/off) show detailed messages during connect to metaserver
motionThresh:             (int) mouse motion threshold
mouseAsShift:             (on/off) use mouse buttons to switch keymaps
mungScrollbarColors:      (on/off) set scrollbar colors to match background colors
name:                     (string) character nick name
newDashboard:             (0-3) dashboard style
# 0 - Text
# 1 - COW
# 2 - KRP (default)
# 3 - LABs

newDistress:              (on/off) indent distress calls to the right
newPlist:                 (on/off) compatibility variable for player list
# on - COW style
# off - old style

newQuit:                  (on/off) use new quit window
newTeams:                 (on/off) use new team windows
omitTeamLetter:           (on/off) omit team letter on galaxy
orishipbmpfile:           (path) - old color bitmaps
oriship1bmpfile:          (path) - new color bitmaps
orishipGbmpfile:          (path) - your own ship's grayscale bitmaps
orishipTbmpfile:          (path) - shaded color bitmaps
orishipMbmpfile:          (path) - mono bitmaps
packetLights:             (on/off) show packets sent and received by blinking dashboard lights
partitionList:            (on/off) add blank line between teams in player list
password:                 (string) password for autologin
phaserShrink:             (0-16) shrink own phaser by x/16 of its length
# 0-16 for COW style phaser shrink
# 0-11 for BRMH style phaser shrink

phaserShrinkStyle:        (0-1) shrink own phasers using specific style
# 0 - COW style (fixed length phaser)
# 1 - BRMH style (phaser shrinks during recharge time)

phaserStats:              (on/off) show phaser statistics
phaserWindow:		  (on/off) whether to show phaser window
planetBitmap:             (0-3) what bitmaps to use for local planets
# 0 - Bronco (default)
# 1 - Moo
# 2 - Rabbitear
# 3 - New color

planetBitmapGalaxy:       (0-3) what bitmaps to use for galaxy planets
# 0 - Bronco (default)
# 1 - Moo
# 2 - Rabbitear
# 3 - New color

planetHighlighting:       (on/off) highlight galactic planets by race and army status
playerList:               (string) custom style of player list
# ' ' - White Space
# 'b' - Armies Bombed
# 'd' - Damage Inflicted (DI)
# 'k' - Max Kills
# 'l' - Login Name
# 'n' - Ship Number
# 'p' - Planets Taken
# 'r' - Ratio
# 's' - Speed
# 'v' - Deaths per hour
# 'w' - War status
# 'B' - Bombing
# 'C' - Curt (short) rank
# 'D' - Defense
# 'H' - Hours Played
# 'K' - Kills
# 'L' - Losses
# 'M' - Display, Host Machine
# 'N' - Name
# 'O' - Offense
# 'P' - Planets
# 'R' - Rank
# 'S' - Total Rating (stats)
# 'T' - Ship Type
# 'V' - Kills per hour
# 'W' - Wins

playerList2:              (string) custom layout for alternate player list window (same as playerlist)
playerListBlankZeroKills: (on/off) don't display player's kills if they have zero kills
playerListHack:           (on/off) if player's letter is greater than 'f' suppose that
                                   the player is observer.
playerListMessaging:      (on/off) allow messages to be sent to players by clicking player
                                   on the player list window

playerlistObserver:       (0-4) what kind of players to show
# 0 - all (default)
# 1 - players
# 2 - observers
# 3 - players, then observers
# 4 - playerlist is off

playerListStyle:          (0-4) what player list style to use
# 0 - custom style as defined in playerList
# 1 - old style "nTRNKWLr O D d "
# 2 - COW style "nTR N  K lrSd" (default)
# 3 - kill watch style "nTK  RNlr Sd"
# 4 - BRMH style "nTR N  K l M"

port:                     (port) default port
port.<server>:            (port) port for <server>
portSwap:                 (on/off) use UDP port swap code (use if you behind NAT)
puckArrow:                (on/off) put a small tic mark on the puck to indicate its direction
puckCircle:               (on/off) show the puck's max shot range as a circle around your ship
redrawDelay:              (0-10) how many updates to wait before redraw
rejectMacro:              (on/off) reject macros
reportKills:              (on/off) report kills
richText:                 (on/off) use rich text message windows
richTextMove:             (on/off) enable rich text windows moving
romshipbmpfile:           (path) - old color bitmaps
romship1bmpfile:          (path) - new color bitmaps
romshipGbmpfile:          (path) - your own ship's grayscale bitmaps
romshipTbmpfile:          (path) - shaded color bitmaps
romshipMbmpfile:          (path) - mono bitmaps
rotatePlanets:            (on/off) rotate planets (only works with new planet bitmaps)
saveFile:                 (path) path to saved options file
saveBig:                  (on/off) save options with remarks
saveBeeplite:             (on/off) save beeplite macros to saveFile
saveMacro:                (on/off) save macros to saveFile
saveRCD:                  (on/off) save receiver configurable distresses to saveFile
saveRCM:                  (on/off) save receiver configurable messages to saveFile
saveWindow:               (on/off) save window placements to saveFile
scaleFactor:              (10-40) scale of local map graphics
server:                   (address) default server (only listed on TCP metaserver)
server.<server>:          (address) <server> is a nickname for (address)
shiftedMouse:             (on/off) shift+mouse buttons will work as commands
showAllTractorPressor:    (on/off) show each player's tractor/pressor beams (requires server support)
showArmy:                 (0-3) show army count next to planets
# 0 - don't show army counts
# 1 - show army counts on local map only (default)
# 2 - show army counts on galactic map only
# 3 - show army counts on both maps

showCloakers:             (on/off) show cloakers on tactical
showHints:                (on/off) show hints window
showHockeyLinesLocal:     (on/off) show hockey lines on tactical
showHockeyLinesMap:       (on/off) show hockey lines on galactic
showHockeyScore:          (on/off) show hockey score on galactic
showIND:                  (on/off) show neutral planets with X over them
showLock:                 (0-3) where to show lock triangle
# 0 - nowhere
# 1 - galactic
# 2 - tactical
# 3 - both (default)

showOtherSpeed:           (on/off) show other player's speed on tactical
showMySpeed:              (on/off) show my speed on tactical
showMotd:                 (on/off) show Motd if waiting on queue
showPlanetNames:          (on/off) show planet names on tactical
showPlanetOwner:          (on/off) show planet owner on galaxy
showStars:                (on/off) show background stars
showStats:                (on/off) show ship statistics
showTractorPressor:       (on/off) show tractors and pressors
shrinkPhaserOnMiss:       (on/off) don't draw phaser line on miss
singleMacro:              (string) macro keys that will trigger macro without macro mode
sortMyTeamFirst:          (on/off) show my team first in the player list
sortPlanets:              (on/off) sort the planet list by team and army count
sortPlayers:              (on/off) sort players by teams
sound:                    (on/off) enable layered, stereo sound
soundVolume:              (0-128) starting sound volume
soundEffects:             (on/off) play sound effects
soundMusic:               (on/off) play music
soundMusicBkgd:           (on/off) play theme music in background
                          (this option requires soundMusic to be on)
soundAngles:              (on/off) use 3D sound effects
soundExclude:             [ewamicso]
# Allow specific sound types to be turned off
# e - explosion sounds
# w - weapon sounds
# a - alert sounds
# m - message sounds
# i - info sounds
# c - cloak sounds
# s - shield sounds
# o - other's sounds

soundDir:                 (path) path to directory containing sound files
theirPhaserShrink:        (0-16) shrink enemy phaser by x/16 of its length
timerType:                (0-4) type of timer on dashboard window
# 0 - don't show
# 1 - current time
# 2 - server time
# 3 - time in ship
# 4 - user-set time
# 5 - game-related timers

tpDotDist:                (int) distance between tractor/pressor dots (default 10)
tractorID:                (on/off) show the ID of player you are tractoring as a number below your ship
tryShort:                 (on/off) enable short packets
tryUdp:                   (on/off) try using UDP
udpClientReceive:         (0-2) how to receive data from server
# 0 - TCP
# 1 - simple UDP (default)
# 2 - fat UDP

udpClientSend:            (0-3) how to send data to server
# 0 - TCP
# 1 - simple UDP (default)
# 2 - enforced UDP (state)
# 3 - enforced UDP (state & weapons)

udpDebug:                 (0/1) debug UDP traffic
udpSequenceCheck:         (on/off) check UDP sequence
updatesPerSec:            (1-50 generally) how many data updates per second to request from server
useCheckPlanets:          (on/off) crosscheck with server to make sure planet info always correct
useFullShipInfo:          (on/off) display other ships to 256 directions instead of 16
useFullWeapInfo:          (on/off) support showing more weapon info on galaxy map
useGeneric32:             (on/off) receive generic_32 server packets which carry repair time, etc.
useLite:                  (on/off) use beeplite
defLite:                  (on/off) use default beeplite settings
useRSA:                   (on/off) use RSA client verification
useRSA.<server>           (on/off) user RSA for <server>
varyShields:              (on/off) change shields graphic on shield damage
varyShieldsColor:         (on/off) change shields color on shield damage
viewBox:                  (on/off) show tactical window boundaries on map
viewRange:                (0-3) show range at which enemies can see you as a circle on map
# 0 - don't show range circle
# 1 - only show range circle when cloaked
# 2 - only show range when carrying
# 3 - show range circle at all times

warnHull:                 (on/off) warn hull state based on damage
warnShields:              (on/off) change shields color on enemy approach
warpStreaks:              (on/off) show streaks while warping to starbase
weaponsOnMap:             (on/off) show phasers, torps and plasmas on galactic map
windowMove:               (on/off) enable internal windows to be moved with mouse

<window>.allow:           [A][T][I][P][K]
# Allow specific messages to be shown in window
# Only valid for message windows (i.e. review_* and review)
# A - show messages sent to all
# T - show messages sent to the team
# I - show messages sent to yourself
# P - show phaser messages
# K - show kill messages

<window>.mapped:          (on/off) show window <window>
# List of possible window names
#
# netrek          Main Window
# local           Main Fighting Window
# map             Galactic Map
# warn            Warning Window
# message         Message Window
# review          All Messages Window
# review_all      Messages to All Window
# review_team     Messages to Team Window
# review_your     Messages to Individual Window
# review_kill     Kill Messages Window
# review_phaser   Phaser hits Window
# planet          Planet List Window
# player          Player List Window
# player2         Alternate Player List Window
# war             War Declarations Window
# fed             Federation Selection Window
# ori             Orion Selection Window
# rom             Romulan Selection Window
# kli             Klingon Selection Window
# quit            The Quit Countdown Clock
# option          Option Menu Window
# rank            Rank Window
# stats           Statistics Window
# tstat           Dashboard Window
# help            Help Window
# UDP             UDP Options Window
# pingStats       Ping Statistics Window
# MetaServer List (including the space) Metaserver window
# macro           Active Macros Window

<window>.geometry:        (geometry) window geometry
# Window Placement syntax
#
# This displays the size, and position of the window.
# <window>.geometry:<width>x<height>+<xpos>+<ypos>
#
# This displays just the position of the window.
# <window>.geometry:+<xpos>+<ypos>
#
# ...or just the size
# <window>.geometry:<width>x<height>

<window>.parent:          (window) <window> is a child of (window)

