Update of /cvsroot/netrek/client/netrekxp/resources/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv20856/resources/docs
Modified Files:
changes.txt hints.dat netrekxp.doc sample_xtrekrc.txt
xtrekrc_options.txt
Removed Files:
cow.doc cow.txt
Log Message:
Removed the two COW manuals and combined the relevant info into the netrekxp manual.
--- cow.txt DELETED ---
--- cow.doc DELETED ---
Index: sample_xtrekrc.txt
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/sample_xtrekrc.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- sample_xtrekrc.txt 12 Apr 2006 04:20:03 -0000 1.2
+++ sample_xtrekrc.txt 21 Apr 2006 11:35:02 -0000 1.3
@@ -464,8 +464,8 @@
dist.^8.doing2: %T%c->%O (%i)%?%a>0%{ has %a arm%?%a=1%{y%!ies%}%} at %b. %d%% dam, %s%% shd, %f%% fuel
dist.^9.pickup: %T%c->%O %p++ @ %l
dist.^0.pop: %T%c->%O %l%?%n>-1%{ @ %n%}!
-dist.^@.other1: %T%c->%O (%i)%?%a>0%{ has %a arm%?%a=1%{y%!ies%}%} at lal. (%d%%D, %s%%S, %f%%F)
-dist.^#.other2: %T%c->%O (%i)%?%a>0%{ has %a arm%?%a=1%{y%!ies%}%} at lal. (%d%%D, %s%%S, %f%%F)
+dist.^@.other1: %T%c->%O (%i)%?%a>0%{ has %a arm%?%a=1%{y%!ies%}%} at %l. (%d%%D, %s%%S, %f%%F)
+dist.^#.other2: %T%c->%O (%i)%?%a>0%{ has %a arm%?%a=1%{y%!ies%}%} at %l. (%d%%D, %s%%S, %f%%F)
dist.E.help: %T%c->%O Help(%S)! %s%% shd, %d%% dmg, %f%% fuel, %?%S=SB%{ %w%% wtmp,%!%}%E%{ ETEMP!%}%W%{ WTEMP!%} %a armies!
dist.^e.escorting: %T%c->%O ESCORTING %g (%d%%D %s%%S %f%%F)
dist.^t.taking: %T%c->%O (%S) Carrying %a to %l%?%n>-1%{ @ %n%}
Index: xtrekrc_options.txt
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/xtrekrc_options.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- xtrekrc_options.txt 12 Apr 2006 04:20:03 -0000 1.2
+++ xtrekrc_options.txt 21 Apr 2006 11:35:02 -0000 1.3
@@ -1,69 +1,39 @@
# This document lists all available options that could be changed
# in xtrekrc file
-# 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)
-
-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
-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
-
+allowWheelActions: (on/off) allow mouse wheel to work in non-scrolling windows
autoQuit: (int) autoquit time after death
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
color.<color>: (color) replace first <color> with (color)
-colorfulPhasers: (on/off) use team color for phasers
+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
+
+colorfulPhasers: (on/off) make your phasers multicolored
continueTractor: (on/off) show tractors after lock
continuousMouse: (on/off) use continuous mouse mode
+continuousMouseFix: (on/off) fix continuous mouse behavior
+disableWinkey (on/off) disable Windows and Context keys
documentation: (path) path to documentation file
enemyPhasers: (1-10) enemy phaser line width
extraAlertBorder: (on/off) change window border on enemy approach
@@ -97,6 +67,7 @@
logging: (on/off) enable logging
login: (string) character login
macroKey: (char, ESC, TAB) key to toggle macro mode
+mainResizeable: (on/off) make main window (netrek) resizeable
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
@@ -105,6 +76,7 @@
# 2 - tactical bottom
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
@@ -133,6 +105,7 @@
# on - COW style
# off - old style
+omitTeamLetter: (on/off) omit team letter on galaxy
orishipbmpfile: (path) - players bitmaps
orishipGbmpfile: (path) - own grayscale bitmap
orishipTbmpfile: (path) - own tainted color bitmap
@@ -144,6 +117,10 @@
# 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 rechange time)
+
phaserStats: (on/off) show phaser statistics
planetBitmap: (0-2) what bitmaps to use for planets
@@ -179,6 +156,12 @@
# 'V' - Kills per hour
# 'W' - Wins
+playerList2: (string) custom layout for alternate player list window (same as playerlist)
+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-2) what kind of players to show
# 0 - all (default)
# 1 - players
@@ -202,10 +185,19 @@
romshipGbmpfile: (path) - own grayscale bitmap
romshipTbmpfile: (path) - own tainted color bitmap
romshipMbmpfile: (path) - monospace bitmap if colorclient=0
+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
server: (address) default server
server.<server>: (address) <server> is a nickname for (address)
shiftedMouse: (on/off) shift+mouse buttons will work as commands
-shellTools: (on/off) enable shell tools
+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
+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
@@ -218,6 +210,7 @@
showMotd: (on/off) show Motd on login
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
@@ -227,6 +220,14 @@
sound: (on/off) enable sound
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
+
tpDotDist: (int) distance between tractor/pressor dots (default 10)
tryShort: (on/off) enable short packets
tryUdp: (on/off) try using UDP
@@ -248,7 +249,19 @@
useRSA: (on/off) use RSA client verification
useRSA.<server> (on/off) user RSA for <server>
varyShields: (on/off) change shields color on shields damage
+viewBox: (on/off) show tactical window boundaries on map
warnShields: (on/off) change shields color on enemy approach
+warpStreaks: (on/off) show streaks while warping to starbase
+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
@@ -266,6 +279,7 @@
# 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
@@ -295,3 +309,4 @@
# <window>.geometry:<width>x<height>
<window>.parent: (window) <window> is a child of (window)
+
Index: changes.txt
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/changes.txt,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14
--- changes.txt 20 Apr 2006 06:48:20 -0000 1.13
+++ changes.txt 21 Apr 2006 11:35:02 -0000 1.14
@@ -1,4 +1,7 @@
Version TBA:
+- updated NetrekXP manual (in docs folder), removed old cow manuals.
+- the new color fed starbase bitmaps now rotate.
+- Keeppeace default is now "on".
- rewrote find bitmap routine in a smarter way (thanks Quozl)
- fixed bccnetrek.rc to have proper header so icon works
- tidied up the save_options function, fixing some spacing errors, and puttting the
@@ -6,10 +9,9 @@
sounddir option.
- fixed mainResizeable loading from rc/saving. Also made default setting = on.
- rewrote TTS centering/refresh code so that text is properly centered and clears
- properly when the message expires. Updated COW manual to reflect change of tts_pos
+ properly when the message expires. Updated manual to reflect change of tts_pos
variable to tts_ypos.
- fixed crash bug in save options due to renaming of .sav file from xtrekrc to netrekrc.
- This bug is not in the downloadable version.
- readded beeplite functionality. Configuration options described in cow manual.
Basic rc options are useLite: on/off to turn beeplite on and off, and defLite: on/off
to use the default settings. The beeplite option is highly configurable, see manual
@@ -25,25 +27,39 @@
- phasering plasma now has less of an effect on phaser average damage statistics, it
is counted as your average damage hit, rather than the previous way of counting it
as a 38 point phaser hit.
-- fixed bug with phaser messages going blank due to improper buffering (not sure where
- this bug came from, in the downloadable version off playnetrek this bug does not exist)
-- removed defunct netrek forum link from metaserver window
-- added "dynamicBitmap: (on)/off". Enables dynamic bitmap switching from the options menu
+- fixed bug with phaser messages going blank due to improper buffering
+- added "dynamicBitmap: (on)/off". Enables dynamic bitmap switching from the options
+ menu
- renumbered the ship bitmap sets for the colorClient option. Choices are 0=mono,
1=new color graphics, 2=single color graphics, and 3=shaded single color graphics.
Default setting is still 1. Settings 2 and 3 have the bonus effect of turning your
ship color to white (similar to COW) due to there being a greyscale bitmap library
with matching ship designs.
-- updated NetrekXP manual (in docs folder)
- fixed hightlightFriendlyPhaser option to work again: on for white phasers on hits,
off for flicker between team color and white
- added some more hints to the hint database
- fixed hint messages so they properly loop
- added Maximize button to title bar
- added buildexe script for compiling solely the source code and not the bitmaps
-- made BCC default compiler and disabled RSA mkkey check (-nt) until it can be fixed
+- made BCC default compiler and disabled RSA mkkey check (-nt) until I get a valid one
-Version 4.4.0.3:
+Version 4.4.0.4: (changes by stas, added 18-Apr-2006 )
+- added "allowWheelActions: (on)/off" to be able to disable wheel in non-scrolling windows
+- added new window "player2" that behaves exactly as player list window, but allows to
+ select alternate custom layout and could be toggled with 'A' key
+- added "playerList2: (string)" option that allows to select different player list layout
+ for alternate player list window, by default it will be "n T R N l M K W L r O D d "
+- fixed bug that caused main thread to continue in case player died while scrolling
+ message window using scrollbar (which forced him close client window and reconnect)
+- fixed incorrect behavior of 'windowMove: off' feature. Previously window would snap
+ back to wrong place if the main window top-left corner was not (0,0) coordinates
+- long lines are now wrapped by words instead of by chars. Maximum message length was
+ reduced to 4 full message lines (4 * 69 characters)
+- message input window will now show Sender->Recipient even when the input line is longer
+ than 69 characters
+- changed 'Forum' URL on metaserver window to open Google's r.g.n location
+
+Version 4.4.0.3: (Released on 11-Jul-2004)
- added "viewBox: (on)/off" to show tactical boundaries on galaxy
- added "omitTeamLetter: on/(off)" to stop drawing team letter on galaxy
@@ -76,7 +92,7 @@
- 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
-Version 4.4.0.2:
+Version 4.4.0.2: (Released on 04-Mar-2004)
- repack of 4.4.0.1 with some bug fixes
Index: hints.dat
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/hints.dat,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- hints.dat 15 Apr 2006 01:04:33 -0000 1.4
+++ hints.dat 21 Apr 2006 11:35:02 -0000 1.5
@@ -107,4 +107,4 @@
starbases can fire phasers twice as fast as any other ship.
"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.
+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.
\ No newline at end of file
Index: netrekxp.doc
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/netrekxp.doc,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- netrekxp.doc 15 Apr 2006 01:04:33 -0000 1.3
+++ netrekxp.doc 21 Apr 2006 11:35:02 -0000 1.4
@@ -1,358 +1,350 @@
-************************************************************
-* *
-* General Documentation for the NetrekXP Client *
-* *
-* Comments, sugestion and bug reports to keyos at keyos.org *
-* *
-* This is modified version of COW.DOC distributed with *
-* 2.02pl2 release of Client Of Win (COW) netrek client. *
-* The point of this version was to change the original *
-* document to match current configuration options of *
-* NetrekXP *
[...1469 lines suppressed...]
+ The following are the arguments for sounds:
+
+/0 Standard window beep (incoming message sound if sound is on)
+/1 - /9 Play nt_message1 - nt_message9 sound.
+
+ Tactical Text Solution for the Tactical Tunnel Syndrome (TTS):
+
+/| .. | displays Text in between via TTS.
+
+ Additional defaults:
+
+planetCycleTime: highlighting time for planets
+playerCycleTime: highlighting time for players
+
+tts_color: color of TTS message (should be dark)
+tts_font: Font (large prefered)
+tts_max_len: Max length of a message
+tts_time: Time a TTS message is displayed
+tts_ypos: y location of the TTS message