Update of /cvsroot/netrek/client/netrekxp/resources/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14821/resources/docs

Modified Files:
	changes.txt sample_xtrekrc.txt xtrekrc_options.txt 
Added Files:
Log Message:
Update to version

Index: sample_xtrekrc.txt
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/sample_xtrekrc.txt,v
retrieving revision
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- sample_xtrekrc.txt	21 Jan 2003 21:27:57 -0000
+++ sample_xtrekrc.txt	12 Apr 2006 04:20:03 -0000	1.2
@@ -172,19 +172,19 @@
 #war.geometry:           +800
 #war.mapped:		off
-#fed.parent:             netrek
+#fed.parent:             local
 #fed.mapped:		on
-#ori.parent:             netrek
+#ori.parent:             local
 #ori.mapped:		on
-#rom.parent:             netrek
+#rom.parent:             local
 #rom.mapped:		on
-#kli.parent:             netrek
+#kli.parent:             local
 #kli.mapped:		on
-#quit.parent:            netrek
+#quit.parent:            local
 #quit.mapped:		on
 #option.parent:          netrek

--- NEW FILE: hints.dat ---
to  disable  this  window  permanently  you  should  add  "showHints: off"  to  your  rc  file
when you are low on planets, you should let the more experienced players pick the armies. Those should not be wasted.
when you are in doubt, you should ask a Commodore, Rear Adm. or Admiral for advice.
when your team has lots of armies, you should not be afraid to pick them. They'll get bombed anyway.
just because you carry armies, that doesn't mean you can't fight.
the team that delivers the most armies wins.
you should have flexible goals.
killing an opponent with a buddy is easier then doing it on your own.
you should always go for the open planet when you are carrying.
it's dangerous to underestimate opponents or overestimate teammates.
sometimes you just have to hope that they miss.
you should not cloak in your own backfield; you will only fool your teammates.
you should send a single distress call after you pick up armies to let your team know that you carry.
escorts should stay between the ogger and the carrier.
you should never kill an ogger who is out of fuel or crippled.
you should get near their planets.
you should use the space people give away when running. 
you should think globally and act locally.
you're not pac-man: do not eat the dots.
you should always shoot at cloakers.
you should watch the galactic map at all times.
you should always tractor enemies off planets.
you should never pass up an opportunity to bomb.
you can't be everywhere at once.
you should not fixate on one target.
planning is good, but opportunism is better.
if an enemy is annoying you by what he is doing, you should consider adopting his strategy.
you should not argue about which planet to take.
nobody completely understands the game. Certainly not you.
you should not tell others what to do.
you should fly at maximum warp to your destination unless you need to turn.
"shut up and play" often is a wise tactic.
you should not waste your fuel firing torpedos that the enemy will dodge.
nobody can dodge phasers. 
instead of flying in circles, you should stop and repair; you'll save fuel. 
you should do the easy things first.
you should always shoot the escort first.
you should try to fight past the enemy's front-line planets.
death is only a temporary setback.
the lines are better than the dots, but the dots go farther.
you should not keep beating your head against the same wall.
you can run from multiple oggers almost as easily as from one.
you should never go out to third space to escort.
you can't make your teammates more clueful, no matter what you type.
you should not chase ships. Be content to occupy the space they left you.
you should not fly to lost plays. You're too late, do something more useful instead.
if you carry armies, you should not go to the same planet another carrier on your team already called.
you should not react to their game, but play your own game.
plasma is for twinks.
you should use the dots to make your lines hit.
you can fire torps in the path of your opponent to force them to slow down.
if you phaser every second you'll win most dogfights.
all the experts fire their next phaser right after the last phaser died away for maximum efficiency.
phasers have a constant cycle time. Learn this and phaser faster than your opponent.
skill does not equal clue.
you should not celebrate dooshes when you are on the team that is cored.
cloaking does not make you invincible.
fuel is your friend. Treasure it.
you can det for a carrier even if you are almost out of fuel.
detting only takes 100 fuel. Spending that 100 fuel on a det can make your carrier very happy.
dying is the fastest way of repairing and refueling.
The best way to defend a starbase is to aggressively attack the enemy oggers.
you should attack them. Yes, you.
buttorping is stupid, unless you are the carrier.
if you want to improve your play, you can observe the better players by joining the observer port (right click on the metaserver).
rank does not equal clue.
you should 1) Maxwarp to the front. 2) Face forward. 3) Attack. 4) Do not buttorp. 5) Die. 6) Goto 1).
practice makes perfect.
nobody said this was easy.
there is no I in team.
it is always a good idea to fly into enemy space.
you should never let an enemy CA live in your backfield.
you should never chase a SC bomber with 0 kills. You can't catch it.
if you feel useless, you can always grab a SC and start SC bombing. People will love you for it.
when you are SC bombing, your job is not to engage enemy ships, but solely trying to bomb as many armies as possible.
starbases are not toys. Do not fly one if you do not know how to fly one. Ask your team if it's ok for you to try one out.
if a starbase dies, it takes 30 minutes to get a new one. Ask your team if it's ok for you to try one out.
information is the most valuable commodity in netrek. Use the teamboard. Read it. Write to it.
you should not be afraid to admit that you screwed up. Trust us, everyone else knows you did.
having a thick skin helps. Saying "sorry, I'm new" if you're being yelled at can work wonders.
everyone has a bad day, try not to take things personal.
you can ignore messages from individual people by sending them :ita. If people are abusive to you, just ignore them.
you should learn to recognize the good players by their login IDs and player handles. They are the best way to get better at this game. Watch them and/or talk to them.
people with an offense rating of over 1.50 are to be respected. Can you maintain an offense of over 1.50?
dying is a good thing. (In netrek anyway).
if you are down to 5 planets or less, you should only bomb the planets outside of your core five. Let the more experienced players decide when to bomb the other ones.
a cruiser (CA), can fly up to warp 9, has 10.000 fuel, 100 hull, 100 shields, 40 pt torps and can do up to 100 pt maximum phaser damage.
an assault ship (AS), can fly up to warp 8, has 6.000 fuel, 200 hull, 80 shields, 30 pt torps and can do up to 80 pt maximum phaser damage.
a battle ship (BB), can fly up to warp 8, has 14.000 fuel, 130 hull, 130 shields, 40 pt torps and can do up to 105 pt maximum phaser damage.
a scout (SC), can fly up to warp 12, has 5.000 fuel, 75 hull, 75 shields, 25 pt torps and can do up to 75 pt maximum phaser damage.
a destroyer (DD), can fly up to warp 10, has 7.000 fuel, 85 hull, 85 shields, 30 pt torps and can do up to 85 pt maximum phaser damage.
a starbase (SB), can fly up to warp 2, has 60.000 fuel, 600 hull, 500 shields, 30 pt torps and can do up to 120 pt maximum phaser damage.
assault ships have the best cloaking capabilities in the game and are mainly used for taking heavily guarded planets.
battleships have the strongest fire power of non-star bases, but they must operate near a fuel planet to be effective.
cruisers are the most well rounded ship, having high firepower and good manoeuvrability.
scouts offer the fastest speed and manueverability, but are best used for bombing or taking. They are too brittle to be used for space controlling.
starbases are the strongest ships in terms of fire power and can only be killed by a concentrated team effort.
"to ogg" means, the process of cloaking and appearing adjacent to an enemy while firing torps and tractoring on to him, with the purpose to kill that player, without caring about dying in the process.
"to doosh" means, killing an enemy ship which is carrying armies. People often yell "doosh!" after they kill a huge carrier. 
a "planet scum" is someone who only cares about taking planets so he gets good ratings. This often hurts the team because the wrong planets are taken, or the planets are taken with little armies and easily captured back.
Index: xtrekrc_options.txt
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/xtrekrc_options.txt,v
retrieving revision
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- xtrekrc_options.txt	21 Jan 2003 21:28:05 -0000
+++ xtrekrc_options.txt	12 Apr 2006 04:20:03 -0000	1.2
@@ -3,25 +3,57 @@
 # Options added since NetrekXP final release
+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
+b4keymap:                 (string) keymap for mouse button 4 (mouseAsShift=on)
+b5keymap:                 (string) keymap for mouse button 5 (mouseAsShift=on)
+continuousMouseFix:       (on/off) fix continuous mouse behavior
+disableWinkey             (on/off) disable Windows and Context keys
+mainResizeable:           (on/off) make main window (netrek) resizeable
+metaPing:                 (on/off) show ping stats to all servers in metaserver window
+omitTeamLetter:           (on/off) omit team letter on galaxy
+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
 phaserShrinkStyle:        (0-1) shrink own phasers using specific style
 # 0 - COW style (fixed length phaser)
-# 1 - BRMH style (phaser shrinks during rechange time
+# 1 - BRMH style (phaser shrinks during rechange time)
 saveFile:                 (path) path to saved options file
 saveBig:                  (on/off) save options with remarks
 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
+showAllTractorPressor:    (on/off) show each player's tractor/pressor beams (requires server support)
+showHints:                (on/off) show hints window
 showHockeyLinesLocal:     (on/off) show hockey lines on tactical
 showHockeyLinesMap:       (on/off) show hockey lines on galactic
-showAllTractorPressor:    (on/off) show each player's tractor/pressor beams (requires server support)
+showHockeyScore:          (on/off) show hockey score on galactic
+showStars:                (on/off) show background stars
+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
+viewBox:                  (on/off) show tactical window boundaries on map
+warpStreaks:              (on/off) show streaks while warping to starbase
+windowMove:               (on/off) enable internal windows to be moved with mouse
 # Options of the NetrekXP final release
 autoQuit:                 (int) autoquit time after death
 b1keymap:                 (string) keymap for mouse button 1 (mouseAsShift=on)
-b2keymap:                 (string) keymap for mouse button 1 (mouseAsShift=on)
-b3keymap:                 (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)
 baseUdpLocalPort:         (port) use this port as base for UDP
 buttonmap:                (string) change mouse button map
 buttonmap-<ship>:         (string) use this buttonmap for ship (sc,dd,ca,bb,as,sb,ga,att)
@@ -87,6 +119,7 @@
 mouseAsShift:             (on/off) use mouse buttons to switch keymaps
 mungScrollbarColors:      (on/off) set scrollbar colors to match background colors
 name:                     (string) character nick name
+netrek.w32caption:        (on/off) when off - shows titlebar in netrek window
 newDashboard:             (0-3) dashboard style
 # 0 - Text
@@ -107,14 +140,6 @@
 partitionList:            (on/off) add blank line between teams in player list
 password:                 (string) password for autologin
-phaserMsg:                (0-5) where to write phaser messages
-# 0 - none
-# 1 - review all
-# 2 - review team
-# 3 - review indiv
-# 4 - review kill
-# 5 - total
 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
@@ -137,7 +162,7 @@
 # 'r' - Ratio
 # 's' - Speed
 # 'v' - Deaths per hour
-# 'w' - War staus
+# 'w' - War status
 # 'B' - Bombing
 # 'C' - Curt (short) rank
 # 'D' - Defense
@@ -196,6 +221,7 @@
 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
 sortPlayers:              (on/off) sort players by teams
 sound:                    (on/off) enable sound
@@ -253,7 +279,6 @@
 # help            Help Window
 # UDP             UDP Options Window
 # pingStats       Ping Statistics Window
-# buttonkeymap    Keymap Window
 # xtrekrc_help    The xtrekrc help Window
 # macro           Active Macros Window

Index: changes.txt
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/changes.txt,v
retrieving revision
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- changes.txt	21 Jan 2003 21:27:57 -0000
+++ changes.txt	12 Apr 2006 04:20:03 -0000	1.2
@@ -1,3 +1,187 @@
+- added "viewBox: (on)/off" to show tactical boundaries on galaxy
+- added "omitTeamLetter: on/(off)" to stop drawing team letter on galaxy
+- added "showStars: (on)/off" to have paradise-like background stars
+- added "warpStreaks: (on)/off" to draw streaks while warping to starbase and having
+  background stars on
+- added "disableWinkey: (on)/off" to allow Windows and Context keyboard keys to be disabled
+- added "timerType: 0-4" to be able to switch timer like in paradise.
+  0 - don't show
+  (1) - show current time
+  2 - show server time
+  3 - show time in ship
+  4 - show user-set time
+- "\" will now reset timer to 00:00:00 and start counting up
+- added "continuousMouseFix: on/(off)" option. If enabled the continuous mouse will follow
+  any buttons that are pressed at the same time. For example if you are steering and
+  firing at the same time this fix will allow both events to occur. Without the fix the
+  behavior was to only allow one button action.
+- sound volume can now be changed using keyboard: 
+  'v' - decrease volume
+  'V' - increase volume
+- planet bitmaps can now be switched through options menu
+- rearranged option menus. moved all show/hide window options to Windows menu
+- added metaserver2.us.netrek.org and metaserver.eu.netrek.org to the default list of
+  servers to try to connect to before falling down to metaCache
+- changed some defaults to help newbies
+- options menu now automatically resizes when switching from one page to another
+- messages can now be up to 1024 characters long. to allow server-side compatibility every
+  message longer than 69 characters is split to chunks of 69 and sent one-by-one
+- planets and players will appear as soon as they enter tactical window bounds. earlier
+  the bitmaps were painted only when their center was entering tactical window
+- repack of with some bug fixes
+- most options in rc file can now have four appearances:
+     1. option.observer: string (i.e. "keymap.observer: aabbcc")
+     2. option.servernick: string (i.e. "keymap.continuum: aabbcc")
+        This one will work only if you have "server.servernick: servername" in rc
+        (i.e. "server.continuum: continuum.us.netrek.org")
+     3. option.servertype: string (i.e. "keymap.bronco: aabbcc")
+        This will work if you either connect from metaserver window (then types are taken from metaserver report)
+        or if you use option "server.nickname" to map server to nickname and then define "serverType.nickname" to
+        be one of "paradise, bronco, chaos, inl, sturgeon, hockey, dogfight" (so you will have two lines is rc:
+        "server.pickled: pickled.psychosis.net" and "serverType.pickled: bronco")
+     4. option: string (i.e. "keymap: aabbccdd")
+  the options are validated in same order (from 1 to 4 where 1 is best match and 4 is worst match)
+- added "window.allow" option to message windows (review, review_all, review_team, review_your, review_kill, review_phaser)
+  The option lets you set type of messages logged into that window.
+  Message types:
+	I - individual messages
+        T - team messages
+        A - all messages
+        K - kill messages
+        P - phaser messages
+  Default settings:
+        review.allow: ITAKP
+        review_all.allow: A
+        review_team.allow: T
+        review_your.allow: I
+        review_kill.allow: K
+        review_phaser.allow: P
+- removed "phaserMsg" rc option, because now you can define where to log phaser messages using "window.allow: P"
+- changed player list to not show any information on hidden players instead of returning your own info like
+  it was before
+- player list is now clickable:
+     LeftClick - send private message to person that was clicked
+     RightClick - send message to own team
+     MiddleClick - send message to all
+- added "playerListMessaging: on/off" rc option to enable/disable clickable player list (also added to options
+  window to be able to do that in-game)
+- added "beepOnPrivateMessage: on/off" rc option. If enabled the client will beep when you receive private
+  message from somebody that is not yourself or god.
+- added "showHockeyScore: on/off" rc option to show hockey score during the game on map
+- changed '-n' command line behavior to opposite. Now the client won't show console window by default
+  unless you run it with '-n' or you start the program from command line.
+- modified help window to show 'Off' for unmapped keys
+- now you can remap keys by pointing at the key in the help window and pushing key you want it to be
+- xtrekrc.txt and netrekrc.txt are also searched during defaults initialization
+- Pig Call will now include binary version number
+- 4th and 5th mouse buttons can now be mapped and used (not tested)
+  button 4 can be mapped as '4'
+  button 5 can be mapped as '5'
+- wheel up and down can be mapped in buttonmap now ('6' for wheelup and '7' for wheeldown)
+- added average phaser hit to phaser statistics
+- added player number to phaser message (Phaser burst hit guest (R0) for 64 points 10:00:01)
+- minor fix in message window. it wasn't refreshed when switching out of netrek with Alt-Tab
+  and coming back.
+- fixed application bitmap that wasn't loaded right. added both big and small bitmaps. So don't panic when
+  you don't see ugly Windows default application icon on your taskbar.
+- pingStats window didn't have base window as parent, so it could float around. Also removed option
+  to display while not logged in.
+- swapped between message windows and dashboard/playerlist. dashboard is now below tactical
+- added help line to metaserver window. clickable links to favorite netrek internet resources
+- fixed minor bug in saveOptions() where first two macro lines of the first macro were not saved
+- added help file to the project (netrek.chm)
+- binded F1 to open help file if it exists in executable directory
+- added "Save options now" menu to options menu
+Versions pre-
+- added command line option '-n' to hide console window that is pretty much useless
+  unless you need to see what is the problem with connection
+- added "metaPing: on/off" to show ping statistics in the metaserver window. The feature
+  was coded by Erik Hietbrink (Shadow Hunter). The feature is enabled by default.
+- macros in macro window can now be scrolled using 'f' - line down, 'b' - line up,
+  'F' - page down, 'B' - page up
+- added "mainResizeable: on/off" to enable resizing of main window (not in-game).
+- fixed the behavior of main window with "windowMove: off" (it wouldn't move too).
+- added "windowMove: on/off" rc option to disable in-game movement of client windows.
+- same for options menu (under Controls menu)
+- Ctrl-g will autologin as guest in the login screen
+- added randomizer for first hint to be shown in hints window
+- added "agriCAPS: on/off" rc option to be able to display AGRI planet names in capital
+  letters on the map window
+- added "agriColor: 0-2" to choose between: 0 - owner race color, 1 - white, 2 - gray
+- hints window can now be closed with "unmap special windows" key (space by default)
+- agri planet names are written in white on the map
+- hints code was rewritten to get rid of hints.dat formatting.
+- fixed code that allowed to gather info on cloaked or in-fog-of-war enemy from playerlist
+- extended "playerlist" rc option to be able to select amount of decimal places in
+  float numbers. 
+  Now it is possible to set "playerlist: nTK1  RNr1 S1d0" in order to see:
+  "R0 CA 0.5  Ensign guest 0.8 2.4 95"
+  or giving old "playerlist: nTK RNr Sd" will give you:
+  "R0 CA 0.50 Ensign guest 0.82 2.43 95.07"
+  Current options that can be followed by numbers 0-2 are: KODSrdBPHkVv
+- macros can now be sent using players from the player list as target. Some default
+  distresses can also be used with playerlist.
+- added hints window. If you're newbie player you will be given some hints on the
+  game. Credits to Charlie ter Horst, Kevin M Bernatz, David Swasey.
+- added showHints: on/off rc option to disable hints window. Don't do that if you
+  still didn't read all of them
+- fixed info/lock in the player list window to work right in case of playerListHack: on
+- added playerListHack: on/off option to fix the problem with displaying
+  observers/players in the player list window while playing on server with
+  old code. If playerListHack is on then every player with letter greater 
+  than 'f' will be shown as observer.
+  This way you can display only players in the player list. 
+  Use 'L' to rotate player list window between: all players/players only/observers only
+- changed maximum number of macro lines to be 500 instead of old 75
 - fixed colorfulPhasers option to shrink in case that shrinkage is used