Client Of Win
Source Package

	INSTALL		Installation guide, standard GNU project
			(See also section 8.0 of COW.DOC)
	COW.DOC		Documentation, text format
	CHANGES		Change log, latest first, abbreviated format
	ChangeLog	Change log, latest first, detailed format
	README.*	Version specific changes and discussion
	README.CVS	Source repository access information
	README.html	Latest version specific detailed change log
	TODO		List of things to be done by developers

Feedback to cow@netrek.org

This file contains the most recent changes to the COW client, with example
.xtrkrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************
1.02 pl2 Feb. 20, 1995
- One year expire time [siegl]
- put back sortPlayers option for unsorted playerlist [Soutter]
- send full update request when joining [siegl]
- Fixed some bugs with galactic map updates [Soutter]
- Fixed some bugs with color map allocations [siegl]
- Added sample xtrekrc file to the docs [siegl]
- audio.c: replaced SIGCLD with SIGCHLD [ahabig]
- config.h.in: include stdio.h for suns [gosselin]

1.02 pl1 Feb. 9, 1995
- phaserShrink option to remove  the bottom of your phaser [Soutter]
- change TTS Y-location [Joseph]
- Ignore Caps_Lock on key events [sheldon (taken from SWINE)]
- Race Colors [Kellen]
- removed message handler for Dashboard [Siegl]
- fixed multi-line macro bug [Soutter]
- metserver window rewritten [Soutter,Kellen]
- playerlist window rewritten [Soutter]
- The player list is now always sorted and so the "sortPlist"
    option has been removed [Soutter]
- The key "/" now changes the playerlist style rather than selecting
    between sorted and unsorted player lists [Soutter]
- Reimplemented the option "showPlanetOwner". [Soutter]
- New layout for the option menus [Soutter].
- Removed the options "mapmode" and "showShields".  Effectively,
    these options are now treated as always being true [Soutter]
- Added range checking on the options "showlocal", "showgalactic", and
    "showLock" [Soutter]
- Redraw the galactic map when you change teams [Soutter].
- All handlers (both for X events and for packets) now return a void
    rather than an integers.  This fixes some compiler errors [Soutter].

*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

sortPlayers: on
#
#  The default for "sortPlayers" is a bit strange and so we recommend
#  that you set the "sortPlayers" option in your .xtrekrc.  The following
#  will impose the old default.
#


ignoreCaps: off
#
#  By default, the caps lock key is now ignored.  If you would like
#  the old behaviour then set "ignoreCaps" to "off".
#

*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

phaserShrink: 10
#
#  possible values: 0-16
#
#  Don't draw the first <phaserShrink>/16 th of your phaser.  This makes
#  it easier to see incoming torps.
#
#  Most people who tested this feature really like it (even thought it
#  sounds weird).
#


playerListStyle: 3
#
#  possible values: 0-4
#
#  This is a new way of choosing which playerlist you want, although
#  newPlist still works.  Options are:
#
#       (0) Custom player list as defined by the
#               playerlist variable above,
#       (1) Old player list,
#       (2) Traditional COW player list,
#       (3) Kill watch player list,
#       (4) BRMH Player list.
#
#       If "playerListStyle" is set, newPlist is ignored.
#       Use the options menu (shift-O) to try the different styles.
#
#  The "Kill watch player list" is a new built in style.  It makes scanning
#  kills easier and it shows the kind of thing klew players were already
#  doing with the "playerlist" option.
#


partitionPlist: on
#
#  Add blank lines to a sorted player list to separate the
#  different teams.
#


metaCache: .metaCache
#
#  Enable caching of meta-server information into the file
#  "$HOME/.metaCache".
#
#  Use "cow -k" to use the cached information rather than waiting
#  to contact the metaServer.
#
#  For more details, see the "MetaServer Options" manual in
#  section (4).
#


metaStatusLevel: 4
#
#  Select the level of detail to be displayed on the meta-server window.
#
#  The status levels are coded as follows.
#
#  0   Servers which have players but not a wait queue.
#  1   + Servers with a wait queue.
#  2   + Servers with nobody playing. (see NOTE1).
#  3   + Servers which have Timed Out for the MetaServer (see NOTE2).
#  4   + Servers which the MetaServer has not been able to connect to.
#


ignoreCaps: on
#
#  By default, the caps lock key is now ignored and so this is not
#  strictly necessary.
#


showPlanetOwner: on
#
#  showPlanetOwner is an old feature that has been reimplemented.
#  When on, the appropriate race letter is drawn next to each
#  planet on the  galactic.
#

tts_time:       25
#tts_max_len:
#tts_font:
#tts_color:      ivory
tts_pos:        20
#
# Some of these are new TTS options.  This set of parameters moves any TTS
# messages to near the top of the screen.  tts_pos is # of pixels down from the
# top to print the message, the other parameters allow control of how the text
# looks.

color.Rom:              tomato
color.Kli:              green2
color.Ori:              light steel blue
color.Fed:		goldenrod
color.Ind:		aliceblue
#
# You can use these resources to change the colors of the race's bitmaps,
# without messing up the border colors and things from the old style
# "color.red" resources.

****************************************************************
4) New manual sections
****************************************************************


MetaServer Options
==================

The MetaServer and the MetaServerCache are provided to help you find a
netrek game to join.  Both services provide a list of the popular
netrek servers.  The MetaServer is neat because provides information
on the number of players at each site.  The MetaServerCache is neat
because it is much faster if you can guess where a game will be.

To access the MetaServer, use the command line switch "-m".  For
example "cow -m".  To access the MetaServerCache, use the "-k" switch
instead.



1) Where to find the MetaServer:

You can use the options "metaport" and "metaserver" to point COW
to a new MetaServer.  The defaults for these options are:

         metaport: 3521
         metaserver: metaserver.ecst.csuchico.edu


2) How to create a list of known servers for the MetaServerCache:

Before you can use the MetaServerCache, you must give COW a file in
which to cache the information from the MetaServer.  Use the .xtrekrc
option "metaCache" to specify this file.  The files path will be
relative to your home directory unless you start the file name with a
slash (/).

For example, to set the cache file to "~/.metaCache" use:

        metaCache: .metaCache

Unlike the MetaServer, the MetaServerCache will not show the number of
people playing at a server.  If a server is contactable, it will be
shown as "Active".


3) How much information will be shown:

You can now control the amount of information that the MetaServer
displays for you by setting the "metaStatusLevel" flag.  The default
is:

        metaStatusLevel: 3


The status levels are coded as follows.

0       Servers which have players but not a wait queue.
1       + Servers with a wait queue.
2       + Servers with nobody playing. (see NOTE1).
3       + Servers which have Timed Out for the MetaServer (see NOTE2).
4       + Servers which the MetaServer has not been able to connect to.

NOTE1: When using the MetaServerCache, "metaStatusLevel" values of
less than 3 are treated as the value 3.  This minimum is enforced
because the cache does not attempt to show the number of people
playing at a site.

NOTE2: If you are a long way from the MetaServer, you are advised to
ignore TimeOut errors.  For example, the MetaServer in America may
have difficulty contacting to a server in Holland while the link from
England to Holland is very good.


4) The Fallback

If you attempt to contact the MetaServer, and the connection times
out, COW will try to show the MetaServerCache instead.

Similarly, if you attempt to use the MetaServerCache, and your
"metaCache" file does not exist, COW will attempt to call
theMetaServer.



Player List Options
===================

1) Configurable Player List:

    I've added a new .xtrekrc option called "playerlist" what it allows
you to do is specify which columns of the player list you want to show
and in what order.  The following is a table of the available columns.

Spc  Let   Name                 Header
---  ---   -------------------- -------------------
  3  'n'   Ship Number          " No"
  3  'T'   Ship Type            " Ty"
 11  'R'   Rank                 " Rank      "
 17  'N'   Name                 " Name            "
  6  'K'   Kills                " Kills"
 17  'l'   Login Name           " Login           "
  6  'O'   Offense              " Offse"
  6  'W'   Wins                 "  Wins"
  6  'D'   Defense              " Defse"
  6  'L'   Losses               "  Loss"
  6  'S'   Total Rating (stats) " Stats"
  6  'r'   Ratio                " Ratio"
  8  'd'   Damage Inflicted(DI) "      DI"
  1  ' '   White Space          " "
PLIST1
  6  'B'   Bombing              " Bmbng"
  6  'b'   Armies Bombed        " Bmbed"
  6  'P'   Planets              " Plnts"
  6  'p'   Planets Taken        " Plnts"
 17  'M'   Display/Host Machine " Host Machine    "
  7  'H'   Hours Played         " Hours "
  6  'k'   Max Kills            " Max K"
  6  'V'   Kills per Hour       "   KPH"
  6  'v'   Deaths per Hour      "   DPH"
PLIST2
  9  'w'   War staus            " War Stat"
  3  's'   Speed                " Sp"

So for example if you just wanted to see names and rank you'd add this
line to your .xtrekrc:

playerlist: NR

     In order for this mod to be in effect you must compile with PLIST
defined, otherwise you will get either of the two currently available
defaults.  The things shown after PLIST1 are only available if you
have PLIST1 defined, the same goes for the things after PLIST2, but
you must have PLIST defined or neither of these will do anything.

dave
gosselin@ll.mit.edu


NOTE FROM SOURCE KEEPER:
PLIST2 is not active in BRM currently.  Some players feel that placing
speed on the playerlist gives a strategic advantage.

NOTE ON SB STATS :
On servers which support the SBHOURS .feature, you will see slightly
different things when you info a SB, or show the SB player on the
playerlist.  The usual offense and defense lines are replaced with SB
kills/hour and deaths/hour.  The kills, deaths, hours and ratio entries
are all the player's SB stats as long as he is in the SB, and his normal
stats otherwise.


2) Predefined "playerlist" styles:

For your viewing pleasure we have predefined some playerlist layouts
that you might like to try.  These predefined styles can be selected
using the "playerListStyle" option in your .xtrekrc or by using the
options menu (shift-O).

The "playerListStyle" options are:

        0: Custom style         = playerlist
        1: Old style            = "nTRNKWLr O D d "
        2: COW style            = "nTR N  K lrSd"
        3: Kill watch style     = "nTK  RNlr Sd"
        4):BRMH style           = "nTR N  K l M"


For backward compatability, the option "newPlist" will still select
between the old style playerlist (off) and the COW style playerlist
(on) if the "playerListStyle" option does not appear in your .xtrekrc.


3) The "partitionPlist" option:

Lets face it, the main role of the player list is so that you can keep
track of who has kills.

To make life easier, the player list is sorted so that enemy and
friendly teams are always in the same place in the list.  However, in
mono it is not immediatly obvious where one team starts and another
team ends.  If the "partitionPlist" option is "on", white space will
be added to the player list to separate your teams from the other
teams and the players entering the game.  In color, this option is not
usually required because the teams are distinct anyway.

Race Colors README
------------------
You can now change the color in which a given race is drawn *without*
having to also change other objects currently drawn in the same color.

The race color defaults to the color in which the race is normally drawn
(ie, Roms are drawn in color.red, which itself defaults to red).

This option defaults transparently to off and uses up NO CPU time in
normal play.  (so there :-b)

resource       default resource       default color
----------    ------------------      -------------
color.Ind:      color.light grey        light grey
color.Fed:      color.yellow            yellow
color.Rom:      color.red               red
color.Kli:      color.green             green
color.Ori:      color.cyan              cyan

###############################################################
#  Example .xtrekrc lines
color.Rom:              tomato
color.Kli:              green2
color.Ori:              light steel blue

This file contains the most recent changes to the COW client, with example
.xtrekrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************

1.03 pl1
- map/unmap the motd window button [dearing]
- RCD docs update [ahabig]
- FTP server switched from infant2 to bigbang [ahabig]
- SGI X crash bug fixed [siegl]
- security enhancements [siegl]

1.03 pl0
- configurable destination macro keys [siegl]
- added lots of tricks to XTREKRC.example [siegl]
- invalid robots race char fix [siegl]
- upgraded to autoconfig 2 [siegl]
- add external rint() replacement function [siegl]
 Fixes by  [Soutter]
*  Added a playerlist option "sortMyTeamFirst".
*  Added phaser shrink options "shrinkPhaserOnMiss" and "theirPhaserShrink".
*  map() now has its own module and is a little faster I think.
*  local() now has its own module and is a little faster I think.
*  Bug fixed: Lock symbol sometimes blurs on the galactic.
*  Bug fixed: Macros of the form "mac.<key>: <defn>" don't work.
*  Bug fixed: Tractors sometimes drawn out of place if shrinkPhasers used.
*  Bug fixed: Local map not updated until you first move.
*  Bug fixed: Playerlist kills not updated when you first enter the game.
*  Bug fixed: Some buttons in the Short Packet window are not always drawn.
*  Bug fixed: When two ships overlap, the resulting color is sometimes black.
*  Bug fixed: Planets on the galactic are sometimes partially erased.
*  Bug fixed: You can write slightly longer messages than can be sent.
*  Bug improved: Stationary players can be hidden by planets on the galactic.
*  Bug fixed: When observing a player, the dashboard does not show
        torps, kills or max armies as it would in normal mode.
*  Bug Fixed: Holding down the `n' key for a few seconds will crash the client.
*  Bug fixed: Obviously dead torps/phasers/plasmas are sometimes drawn.
*  Bug fixed: The why-dead message is slightly different after window refresh.
*  Bug Fixed: Failed meta-server reads effect the metaCache file.
*  Bug Fixed: No positive feedback of selection from the meta-server window.


*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

1.03 pl1

The WQ window looks different now and there's no way to get back
the old one ;)

1.03 pl0

No changes visible exept all the bug fixes :)

*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

1.03 pl1

No new features

1.03 pl0

#
# Set symbolic names for macro
# key.[key].[dest]:	[name of key]
# If the destination isn't specified the key default to team.
# Set the actual destination by sending a message:
#	set [name of key] [destination id]
# to the shell ("!")
#
key.C:		captain
# Set Captian  to target player
mac.^C.!:	set captain %g
# Macros to the captain.
mac.o.C:        Hi Captain let me suggest a base ogg?
#
key.B:		base
# Set Base to target player
mac.^B.!:       set base %g
# Macros to the Base
mac.a.B: 	BASE: Free armies for me?
#
key.m.A:        me
# set the me (m) key to myself
mac.^m.!:	set me %c
# some Macro sent to myself
mac.t.m:        TIME



theirPhaserShrink: 6
#
#  Range: 0-16
#
#  How much to shrink everybody else's phasers by.  "phaserShrink"
#  still effects your own phasers.
#


shrinkPhaserOnMiss: on
#
#  If on, a phaser is shrunk even if the phaser does not hit.
#


sortMyTeamFirst: on
#
#  This option only applies if "sortPlayers" is on.
#
#  With this option, the playerlist is order with your team at the top.
#  Otherwise, the playerlist has the enemy team(s) first.
#


****************************************************************
4) New manual sections
****************************************************************

***************************************************************
* Symbolic names for macro destinations - Kurt Siegl 27/4/95
***************************************************************

You always wanted to send a macro directly to the captain, base,
or the second SC bomber?

Symbolic macro keys will solve your problems. Here how it goes:

In the .xtrekrc file you assign a key to a symbolic name:

	 key.[key].[dest]:	[name of key]

If the destination isn't specified the key defaults to team.

Examples:
key.C:		captain
key.B.t:	base
key.m.A:        me

Then you can use that new key in your macros.

Examples:
mac.o.C:        Hi Captain let me suggest a base ogg?
mac.a.B: 	BASE: Free armies for me?
mac.t.m:        TIME

Finally during runtime you may change the actual destination
by sending a message:

	set [name of key] [destination id]

to the shell ("!") tools. Of corse this may be done with macros as well.

Examples:
mac.^C.!:	set captain %g
mac.^m.!:	set me %c

You can check the settings on the shell tools window "M".


***************************************************************
Connection Types: UDP and TCP explained
***************************************************************

UDP provides an unreliable, packet-based protocol for sending data
across an IP network.  There are a variety of ways that a UDP packet
can be lost or discarded, including a failure of the underlying
communication mechanism.  UDP implements a checksum over the data
portion of the packet.  If the checksum of a received packet is in
error, the packet will be dropped with no indication given to the
user.  A queue of received packets is provided for each UDP socket.
This queue has a limited capacity.  Arriving datagrams which will not
fit within its high-water capacity are silently discarded.

Guest              Rd     71       27            2% /  13%

The stats above show a typically UDP connection.  It has loss of
packets but its round-trip times are fairly low.


TCP provides a reliable, flow-controlled, in order transfer of data
across an IP network.  There is nothing fundamentally different about
the way UDP and TCP packets travel over the wire.  The only real
difference is that TCP will keep sending the same packet over and over
again until it gets an acknowledgement back.  As a result, TCP
connects are typically slower than UDP connections and usually require
more bandwidth.  TCP is slower because it guarantees that packets will
arrive in order and so a lost packet can hold up later packets.

Example:

Guest          Ff    405      669            0% /   0%
                     ^^^      ^^^            ^^^^^^^^^

The above shows possibly the same connection with UDP turned off.
There is no loss but the round trip times are much higher.


NOTES:

*  COW always uses TCP for some things.  For example, the text messages
   that you can send to other players are implement in TCP to guarentee
   that they always arrive.  However, if a UDP connection is also
   available, it is used for the vast majority of communication.

*  COW will fall back to using a TCP only if it fails to open
   a UDP link.  If you find that you have high lag and no loss, you
   probably should display the UDP control window (the default key is
   `+') and turn UDP back on by pressing the top button.

*  You are recommended to use a TCP connection if you are at the same
   site (within a few milliseconds lag) of the server you are playing on.
   The main reason for using UDP is to reduce your round trip times.

*  The option "tryUdp" can be used to set a preference for using
   UDP (tryUdp: on) or TCP only (tryUdp: off).

This file contains the most recent changes to the COW client, with example
.xtrekrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************

2.00 pl0
- LABs newest dashboard [lab]
- cleanup dashboard .xtrekrc defaults -> newDashboard is int [siegl]
- COW api - shared libs, java and Netscape plugin support [siegl]
- support for WIN95 and NT [jshekter,greynite]
- improved sound system [jshekter,siegl]
- split up cowmain.c from main.c [siegl]
- highlight friendly phasers [ellisj]
- censor (obscenities filter) [ellisj]
- Wide enemy phaser fix [koconnor]
- Kathy replaced by stars [Kellen, majority vote]
- Colormap Option [Kellen]
- fix array overflow in metaserver Win [siegl]

*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

2.00 pl0

The dashboard .xtrekrc defaults handling changed.

The boolean

	newDashboard

option is now and int default and

	newdashboard2

default is obsolete now. So you should use now on of:

# Text dashboard
newDashboard: 0

# COW style dashboard
newDashboard: 1

# KRP style dashboard
newDashboard: 2

# LABs new dashboard
newDashboard: 3


*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

2.00 pl0

	# LABs new kewl dashboard
	newDashboard: 3

The .xtrekrc entry for the highlightFriendlyPhasers option is:

	highlightFriendlyPhasers: on

What does it do?  If on, friendly phasers that hit turn white, just like your
own phaser did before.

Jon Ellis has made some patches which he describes as "what if you
wanted your little sister to play some netrek?".  In short, if you turn on this
option with the .xtrekrc option :

	censorMessages: on

then a list of obscenities in messages are filtered out.  No change unless you
specifically turn it on.


Color map option:

 [-n]   use nearest colors in shared colormap

I really hate the flicker caused by changing colormaps.  Especially when
the colors cow wants are already allocated (ie, Waitqueue 5 at bigbang,
time to kill time elsewhere).

This patch adds the '-n' option, to accept the nearest match color rather
than allocate a whole new colormap.

Michael


****************************************************************
4) New manual sections
****************************************************************


newDashboard:	(integer 0-3) new dashboard 1 and 2, has sliding bars instead of
		numbers at the bottom of the screen, 3 uses triangle sliders,
		definately worth a look.

This file contains the most recent changes to the COW client, with example
.xtrekrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************

2.02 pl2 May 31, 1997 - final stable NO pixmap release
- NO expiry date
- NO background images, kathy, stars, ...
- NO colored planets
- BEEPLITE is off (exept TTS and sound) unless explicitly turned on by server

2.02 pl1 Feb. 28, 1997
- GMP and XPM autoconfig fixes [siegl]

2.02 pl0 Feb. 15, 1997
- scrolling message windows stolen from BRMH [siegl]
- colored planets on galactic map [kellen]
- high color fixes [kellen]
- phaser stats and fixed PhaserMsg [greynite]
- replace all exits with clean returns [siegl]
- netscape plugin version included [siegl]
- GMP 2.0 support [siegl]


*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

2.02 pl2

Borgish features have been completley removed and are not able
to turn on.

2.00 pl0

The showPhaser default has been replaced by PhaserMsg which translates
in the following way:

Old showPhaser:
  0 = don't show
  1 = show on kill window
  2 = show on phaser window
  3 = show on total review window only

New PhaserMsg:
  0 = Don't log phaser hits
  1 = Log phasers on all window
  2 = Log phasers on team window
  3 = Log phasers on indiv window
  4 = Log phasers on kill window
  5 = Log phasers on review window

If the phaser window is mapped it is logged there aditionally.

Message windows have now Scrollbars which are on per default.
You get the the old behaviour by turning it off:

	ScrollBar: off

*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

2.00 pl0

All new .xtrekrc entrys with defaults are:

 #     PhaserMsg: 2
 #     PhaserStats: off

 #     colorgalactic: off
 #     ownerhalo: off
 #     showstars: off

 #     macroKey: X

 #     ScrollBar: on
 #     ScrollBarWidth: 5
 #     ScrollSaveLines: 100

 #     message.mapped: 1
 #     messageHUD: 0
 #     messageHoldThresh: 0

Just turn them all on to get the new features

****************************************************************
4) New manual sections
****************************************************************

Can use color pixmaps instead of bitmaps on galactic.
resource-- colorgalactic:    off

Use starry background on galactic map.
resource-- showstars:    off

Draw a circle in the owning team's color around planets (pixmaps only)
resource-- ownerhalo:    off

o Phaser hits can now be logged in different places.
  resource--  PhaserMsg:   2

  0 = Don't log phaser hits
  1 = Log phasers on all window
  2 = Log phasers on team window
  3 = Log phasers on indiv window
  4 = Log phasers on kill window
  5 = Log phasers on review window

****************************************************************
5) Changes details
****************************************************************

Detailed changes by Michael Kellen:

  + Pitiful but legible greyscale pixmaps.  The greyscale maps should
    be used automatically on a Greyscale visual.  I have not checked
    to see if this actually works automagically.  It depends upon the
    value of W_Visual->class.   [nod to James Soutter for the idea]

  + FEATURE PACKET support for the agri-specific bitmaps.  If the server
    does not understand feature packets or sets AGRI_PIXMAP to false,
    the regular planet pixmap is used. [nod to rgn comments]

  + A colored circle can be drawn around the pixmap to indicate the
    team which owns the planet.  [nod to someone ... I lost the letter]

  + On/Off controls for all pixmap stuff in both rcfile & options menu

  + Compatible with -n startup option

  + Compatible with private colormap

  + Turns off pixmaps and remembers to keep them off if they cannot be
    created for some reason  [nod to PictureMeNaked on the crappy Xterm]

  - Artwork still sucks. [raspberry to me]

This file contains the most recent changes to the COW client, with example
.xtrekrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************

3.00 pl3 Jan. 2, 2000
- Expiry date removed [siegl]
- minor bugfixes [various authors]

3.00 pl2 Jan. 7, 2000
- New default portSwap for UDP_PORTSWAP feature [siegl]
- System wide .xtrekrc file set to "/etc/netrekrc" [siegl]
- Cambot recording replay [koconnor]
- various Win32 fixes [siegl]
- V,B core dump with rabit ears fix [siegl]
- remove DEFINES (BRMH NEW_DASHBOARD_2 RABBIT_EARS) [siegl]
- MAX_MACRO increased to 255 [siegl]
- -B options for automatic bug sumition [siegl]
- new sample netrekrc file [siegl]
- WindowMaker docking support [siegl]
- Win32 Sound support [siegl]

3.00 pl1 Mar. 27, 1999
- Added UDP queries to the metaserver. [cameron, villalpando]
- Added Multiple metaserver support. [cameron, villalpando]
- Metaserver KEYGOD alias: clientkeys@clientkeys.netrek.org [villalpando]
- New xtrekrc variables: metaverbose, metaUDPcache, metaType [cameron,
                                                             villalpando]
- modified behavior of metaserver to do multiple metaservers [cameron]
- changed metaserver menu. Added age of data and refresh button [cameron]
- new option, -M for TCP metaserver [cameron]
- changed option -m for UDP metaserver [cameron]
- Port to Cygnus Win32 [siegl]
- Autoconfig detects Cygnus Win32 [siegl]
- Win32 fixes [Gosselin]
- Fix Pixmap transparancy [siegl]
- Added hockey rink background XPM on galactic [siegl]

3.00 pl0 Feb. 28, 1998
- full color client [kellen]
- metaserver defaults to: metaserver.netrek.org [sven]
- new cow mailing list alias: cow@netrek.org [sven]
- 32 views color pixmaps [Shawn]
-- recording feature [koconnor]
- KDE sound support (.wav files) [siegl]
- Tab key fixes  [koconnor]
- OpenVMS fixes [cameron]
- Auto upgrade via netscape [siegl]
- whydead message fixes [siegl]
- GMP 2 key generator fix [siegl]



*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

3.00 pl0

     The "-b" option disables the use of color pixmaps by the client.


*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

3.00 pl1

WARNING: Sometimes the colored ships have color disturbences
         when having the shields up. In this case start COW
         with the option:

             [-n]   use nearest colors in shared colormap

3.00 pl0

All new .xtrekrc entrys with defaults are:

#       backgroundPix: 1
#       cloakPix: 1
#       explosionPix: 1
#       fedPix: 1
#       indPix: 1
#       kliPix: 1
#       mapPix: 1
#       oriPix: 1
#       romPix: 1
#       shipPix: 1
#       weaponPix: 1


****************************************************************
4) New manual sections
****************************************************************

3.00 pl0

   3.1.8  NO PIXMAPS OPTION

     The "-b" option disables the use of color pixmaps by the client.


   3.2  Pixmaps  (Full Color COW)

     With the release of COW 3.00, dynamic color images are available.  No
color images have been compiled into the client, so without the additional
files (described below) the client will behave as before.

   3.2.1  Setup

     The xpm files should be available at the same site from which you got
the client, in a file named pixmaps.tgz (PIXMAPS.ZIP for windows users).

>>>   YOU MUST DOWNLOAD AND UNPACK THIS FILE TO USE THE COLOR FEATURES.    <<<

     It should create a subdirectory named "pixmaps" which should have several
(obviously named) subdirectories.  There should be several XPM files in each
(except for Planets, which has a further subdirectory).  UNIX users will see
that they are gzipped to save space.  You do NOT need to ungzip them unless
you do not have gzip on your machine.

>>>   DO NOT REARRANGE OR RENAME THESE FILES IF YOU WANT TO USE THEM.      <<<

     You need to add a line to your .xtrekrc telling the client where to look
for the pixmaps.  If you do not, it will assume that they are in a subdirectory
of the directory you are in when you start the client.  The option is called
"pixmapDir".  Tilde and environment variables WILL NOT WORK.  Relative paths
will only work if you always start netrek from the same directory.

     You should be ready to rock and roll.  Fire it up.  You may see some
warnings about not being able to read some pixmaps.  Some of the pixmaps
that the client looks for haven't been drawn yet.  Feel free to make your
own set.  OTOH, if you see any lines which read

 "TYPE <type> PIXMAPS NOT AVAILABLE"

it means that none of a certain type of pixmap were found.  Check to make sure
that the pixmaps are where you told it to look.  If they are, and you are on
a UNIX system, you may not have gzip installed.  Go get it from any GNU mirror
and either install it or use it to ungzip the XPM files.

   3.2.2  Configuration

     In addition to simply creating your own XPMs with a paint program, you
may want greater control over the pictures used.  For example, you may find
the explosions are too pretty, and you are dying because you forgot to dodge.
The crude approach is to just remove that pixmap.  The client will default back
to the standard bitmaps in this case.

     The more elegant approach is to turn off just those pixmaps you don't
like and keep the rest.  This also allows you to switch back and forth WITHOUT
having to exit and restart.  So if the machine you are playing on is busy
today, you can turn off the pixmaps until things improve, then switch back to
full color without losing your 5 kills.

     Pixmaps can be turned on or off in groups on the new "Pixmap Menu" in the
options window (shift-O).  Each line in the window also corresponds to an
.xtrekrc resource which you can use to set the initial values.  If one type
of pixmaps is not available, you will be unable to turn on that option.

     resource name          default      description

       indPix                on      \
       fedPix                on       |  Control whether or not the XPMs
       romPix                on       |  for the ships of a given team
       kliPix                on       |  should be used
       oriPix                on      /

       weaponPix             on          Torps and plasmatorps & their clouds
       explosionPix          on          ship and starbase explosions
       cloakPix              on          fade-in/-out and cloak icon
       mapPix                on          Color Planet icons on galactic
                                         (replaces the "colorgalactic" option)

       backgroundPix         on          Background stars & genocide/gb images
                                         (replaces the "babes" option)

       ownerhalo             off         Draws a colored ring around each
                                         planet on the galactic

as a convenience, the option "shipPix" may be used to control all of the
ship XPMs in one line.

         ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
         +         POWER USERS                                        +
         +                                                            +
         +  The MegaResource "pixFlags" can be used in your .xtrekrc  +
         +  to save a bit of typing.  Simply bitwise OR together the  +
         +  things you want turned off:                               +
         +                                                            +
         +       0x0001    IND pixmaps                                +
         +       0x0002    FED pixmaps                                +
         +       0x0004    ROM pixmaps                                +
         +       0x0008    KLI pixmaps                                +
         +       0x0010    ORI pixmaps                                +
         +                                                            +
         +       0x0020    Weapons                                    +
         +       0x0040    Explosions                                 +
         +       0x0080    Cloaking                                   +
         +       0x0100    Galactic Map Planet Icons                  +
         +                                                            +
         +       0x0400    Backgrounds                                +
         +                                                            +
         +       0x1000    Halos                                      +
         +                                                            +
         +  so, for exaple, no halos and no explosions would be       +
         +  specified as:  (0x1040=4160)                              +
         +                                                            +
         +    pixFlags:  4160                                         +
         +                                                            +
         +                                                            +
         +  (Note that this OVERRIDES all the other resources)        +
         ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


     If you hate them all, you can either set the "pixmapDir" to "None" or
start the client with the -b (bitmap only) command line option.  Then go ahead
and delete all of the XPMS.  Go ahead.  We don't mind at all.  It's not like
we put any WORK into this ...  :,-(

   3.2.3  Babes/M31 and Generalized Backgrounds

     Gone.  You can put up any picture you like when you GENO, GB, or just
enter or hit shift-K.  Just specify the genocide.xpm, ghostbust.xpm and/or
hello.xpm.  It's really none of my business what you look at in your off time.

     Absolutely no picture will be shown if you do not have an XPM in the
specified place.  It didn't belong in the client in the first place.

     DEAL WITH IT.

     And BTW, the ' key (quote) has the default action of retiling your local
and galactic windows with the normal background (either black or your specified
pixmap) to repair the damage done by the other possible pix.

   3.2.4  AGRI pixmaps and FEATURE_PACKETS

     The client shows a different pixmap for AGRI planets than all others.
This was announced, voted on and overwhelmingly adopted (80%+ in favor). But
JUST IN CASE, this option can be disabled at the server by use of the
feature packet "AGRI_PIXMAP".

     Users can choose to remove the AGRI.xpm file.  The client will default
to using the regular planet pixmap if it is missing.


****************************************************************
5) Changes details
****************************************************************

3.00 pl0

From: James Cameron <cameron@stl.dec.com>
Subject: COW 2.02pl2 OpenVMS Patch [Resend]

The last time I built COW for OpenVMS was back in 1994, when it was
1.01pl0.  Since my department is releasing a CD-ROM to it's private
customers I was asked to provide a variety of Netrek software, as
pre-built binaries for OpenVMS, Digital UNIX, and others.

So I took 2.02pl2 and got it working again on OpenVMS.  The new DEC C
compiler on OpenVMS was quite reasonable about the code and had no
significant trouble.  I submit the patch to you for consideration.

The changes were

    -   removal of fopen declarations from functions, as it conflicted
        with the OpenVMS variant of (const char *, const char *, ... )

    -   a macro replacement of the select() call so that OpenVMS
        specific code could be called; the X-Windows implementation on
        OpenVMS does not support the use of ConnectionNumber() and
        select() to wait on X events.  Code to support this was split
        out into a new file, vmsio.c.

    -   suppression of the tools window behaviour, in the same manner as
        on WIN32, since SIGCHLD and popen() are only available in recent
        OpenVMS versions.

    -   minor changes to vmsutils.c to comply with ANSI standard on
        initialisation of structures, (before I found the qualifier to
        turn off strict ANSI checking).

    -   a new file config.h.vms, with OpenVMS version checking to work
        around old versions of OpenVMS.

I've attached the patch to this message in MIME format.

Strangely, the patch included cflags.c changes.  I'm not sure why
cflags.c should be in the manifest ... it created a needless diff output
for it.

Would you have preferred me moving the OpenVMS specific files into a
subdirectory?

For your interest, the 1.01pl0 port I did evolved into a bridged client,
using serial I/O that was OpenVMS specific.  This allowed me to run the
Netrek protocol over a 14k4 modem without any SLIP or PPP overhead.
Now, of course, OpenVMS has joined the ranks of operating systems
providing serial internet protocol layers, and so my work is no longer
required.  Moving to 33k6 also helped.  ;-)

--
James Cameron                                    (cameron@stl.dec.com)
Digital Equipment Corporation (Australia) Pty. Ltd. A.C.N. 000 446 800

3.00 pl1

From: Jonathan Ellis <ellisj@cs.byu.edu>

(1)
Replaced WINSIDE #define for SMALL_SCREEN with TWINSIDE and GWINSIDE for
independent specification of tactical and galactic sizes on machines with
painfully small displays.  (I prefer to use a smaller galactic with a
full-size tactical.)  A lot of other functions used WINSIDE besides the
actual drawing routines--mostly computing default window geometries.  I
tried to keep it consistent with the original look, but I might have goofed
in a couple places.

(2)
cowmain changed so that if no server is specified, it tries to connect
to the metaserver.  This is much better behavior IMHO.

Note: COW.DOC states, "The compiled in default server is bronco.ece.cmu.edu"
This seems to be outdated:

grep bronco *.c *.h
defs.h:#define DEFAULT_SERVER   "bronco.ece.cmu.edu"

grep DEFAULT_SERVER *.c *.h
defaults.c: * Otherwise we try DEFAULT_SERVER. */
defs.h:#define DEFAULT_SERVER   "bronco.ece.cmu.edu"

Note that the only time DEFAULT_SERVER was used is inside a comment (that,
apparently, doesn't reflect the actual code.

(3) added description of highlightFriendlyPhasers, censorMessages, and
    the new default server behavior to COW.DOC.

(4) removed from COW.DOC:
	"Multiline macros are no-longer allowed at all.
         Primarily this is based on network traffic arguments."
    I suppose it's historical, but outdated documentation isn't cool.

(5) Added note to COW.DOC that not specifying any plist options will
    default to old plist.  (This wasn't obvious to me because 2 is called
    the "traditional" plist... perhaps an unintended connotation.)

(6) removed from socket.c
#ifdef FOR_MORONS
  {                                              /* it _is_ an 'info' borg,
                                                  * after all.  ;-) */
    extern int For_Morons;

    if (For_Morons)
      return;
  }
#endif

FOR_MORONS and For_Morons appeared nowhere else.
I assume this is obsolete code.

(7) removed from data.h
extern int babes;
    after all, they're gone. ;)

(8) merged the "Moo" docs (section 8 of COW-DOC) with the rest of it.
    It had to happen sometime.  Cope.  (This includes a bunch of minor changes
    that I won't ennumerate.)

a. replaced an inaccurate line of defwin.c with
    "warnShields", BOOL_DEF, "Shield color based on alert status",

b. someone who understands the server's ntserv/socket.c needs to explain
   what udpClientRecv really does.  "simple" and "fat" don't say a whole
   lot.  I don't have time to try to learn the server-side code right now.

(9) the option menu as well as the example .xtrekrc claimed that the udpDebug
    resource took different options:
    0 = OFF   1 = ON (conect msgs only)  2 = ON (verbose output)

    but in the code, udpDebug == 1 behaved exactly the same as udpDebug == 2
    I tried to changed this to reflect the documentation by taking out
    all the UDPDIAG but printUdpInfo from udpDebug == 1.

(10) <superceded by 11>

(11) defaults.c: deleted legacy code from findDefaults dealing with server-
     specific .xtrekrc files.  The code was broken (try it: move .xtrekrc
     to .xtrekrc-continuum, or whatever--it won't work).  I don't know how
     long it's been broken, but

  if (serverName)
    {
    sprintf(serverfile, NETREKRCSERVER, serverName);
    if (findfile(serverfile, file))
      return 1;
    sprintf(serverfile, XTREKRCSERVER, serverName);
    if (findfile(serverfile, file))
      return 1;
    }

     never gets executed because serverName hasn't been initialized by the
     (first) call to findDefaults.  If anybody actually used this feature
     there would have been complaints that it was broken... since, apparently,
     nobody really cared, I just got rid of it.  Simplify, simplify. ;)

Also: reread_defaults in input.c and newinput.c didn't work the way it was
      apparently intended to if no rc file was present.  In order to get it
      to issue the warning that none was found, some things had to be
      changed, including initializing defaultsFile in data.c to "" instead
      of ".xtrekrc"

(12) removed unused variables from dmessage.c
  char    cmupigcall[80];
  char    pigcall[160];

(13) The ghost start option is still present in the code, but it doesn't
     seem to work.  I have no clue what's wrong (possibly a server problem?)
     or if the idea is just inherently problematic.  I left the documentation
     in, though, and even added it to what -u prints out.

(14) Added -i to printUsage

(15) Removed from options.c
char   *mapupdates[] =
{"Don't update galactic map",
 "Update galactic map rarely",
 "Update galactic map frequently",
 ""};
     apparently this isn't used anymore.

(16) changed hard-coded geometries to be more sane, with focus on creating
     #ifdef-d alternates for SMALL_SCREEN.  Parents of some windows were
     changed, so it should look pretty much like you'd expect without any
     foo.geometry: in your .xtrekrc.

(17) Combined newPlanetBitmaps and whichNewPlanetBitmaps resources with
     showLocal/showGalactic.  Cleaned up code in local.c.  map.c doesn't
     perform the same things local.c does with equivalent options, but
     this is the bitmaps' fault.  moobitmaps.h and rabbitbitmaps.h would
     need to be modified extensively.  That's not my department. ;)

ObBugReport: cloaking doesn't display correctly on my linux machine with
pixmaps on; there's no state in between fully cloaked and fully uncloaked.
One update you're visible, the next you're not.  Very disconcerting.

Other ideas: (sort of an addenum to the TODO ;)

html-ize the new COW.DOC.  cow.html was more than two years out of date
even before my changes. ;)  If COW.DOC were consistant in its use of section
and subsection numbering this could be automated.
	a. "highlight" default value for xtrekrc options

Make the xtrekrc sections of COW.DOC consistant with the shift-O menus and
defwin.c (i.e. use the same categories for all three)

********************************************************************
March 1999
********************************************************************

(1) ------
   Added UDP metaserver, and multiple metaserver queries to client.

   Multiple metaservers is available only in UDP mode.  Multiple
   metaservers may be listed in the metaservers variable, or a host name
   may have multiple IPs.

   Client essentially sends a '?' using UDP to the metaserver(s) and
   waits for a response.  Client should expect anywhere from 0 to
   infinite responses. Response comes back in the form:

      r,NN\n

   Where r is the literal 'r', and NN is the nuber of servers
   returned. Server format is 1 per line in the following format, comma
   separated: (from the metaserver code snippet from disp_udp.c)

        sprintf(bp,"%s,%d,%d,%d,%d,%d,%c\n",
            sp->hostname,               /* host name of server          */
            sp->port,                   /* port number of server        */
            extendedstatus,             /* metaserver status code       */
            now - sp->last_update,      /* age of data in seconds       */
            sp->player_count,           /* count of players on server   */
            sp->queue_size,             /* length of wait queue         */
            sp->type[0] );              /* type code, B, P, etc         */

   Two notes are required:

      1) Line length is defind in the metaserver as:
         MAX_HOSTNAME+1 +6+1 +3+1 +6+1 +3+1 +3+1 +1+1 +1
            host        port stat age  play que  type \n

   where MAX_HOSTNAME is
        #define MAX_HOSTNAME     64

   An example output is:

     r,19
     hp06.ee.ualberta.ca,2592,6,244,0,0,P
     megalag.netrek.org,2592,4,1780,0,0,F
     moore.machine2.dsl.psn.net,2592,6,1804,0,0,B
     netrek.unh.edu,2592,6,524,0,0,B
     paradise.games.uk.demon.net,2592,6,1604,0,0,P
     tanya.ucsd.edu,2592,4,1781,0,0,P
     defiant.theo-physik.uni-kiel.de,2592,3,630,0,0,P
     europa.informatik.uni-frankfurt.de,2592,3,676,0,0,P
     mit.netrek.org,2592,3,676,0,0,B
     netrek.cs.mcgill.ca,2592,3,796,0,0,B
     netrek.syd.att.net.au,2592,3,800,0,0,B
     se.netrek.org,2592,3,864,0,0,B
     soda.csua.berkeley.edu,2592,3,878,0,0,B
     spamburger.openface.ca,2592,3,871,0,0,B
     kirk.hal-pc.org,2592,2,121,1,0,B
     continuum.us.netrek.org,2592,2,123,6,0,B
     hockey.netrek.org,2592,2,123,6,0,H
     monster.wormwood.org,2592,2,203,7,0,C
     guinness.crhc.uiuc.edu,2592,1,323,0,4,B


 2) In TCP mode, if a game server is dead, the metaserver will print
    out sp->why_dead instead of sp->status.  Since metastatuslevel
    filters out the metaserver output based on the game server status,
    sp->status had to be expanded in the metaserver to extended status
    when reporting back to the client.  From disp_udp.c in the
    metaserver:

        /* this if structure is to satisfy COW's server filtering based on */
        /* the TCP ouput of the metaserver. TCP was text, this is only #s */
        if (sp->status == SS_NOCONN )
          extendedstatus = (sp->why_dead == WD_TIMEOUT) ? 6 : 4;
        else
          extendedstatus = sp->status;

   And in the client, parsemeta.c:

     #define SS_WORKING 0
     #define SS_QUEUE 1
     #define SS_OPEN 2
     #define SS_EMPTY 3
     #define SS_NOCONN 4
     #define SS_INIT 5
     /* not a real metaserver number, but overcomes a limitation of dropping */
     /* text description of sp->why_dead */
     #define SS_TOUT 6


   This note is here mainly for people looking at metaserver and
   client code at the same time.

(2) ---
    A refresh button was added to the client selection window to re-query
    the metaservers.

(3) ---
    KEYGOD changed to clientkeys@clientkeys.netrek.org

(4) ---
    New command line option behavior was added. -m and -M set the default
    connection type to the metaserver UNLESS metaType is defined in the
    .xtrekrc.

       -m Default to UDP
       -M Default to TCP

    Out of bounds values for metaType default to TCP.

This file contains the most recent changes to the COW client, with example
.xtrekrc options to deal with them, and the clips from the documentation that
explain them.  If you're upgrading from an old version of COW, this file should
make it a painless experience.

*****************************************************************
1)  Change Log
*****************************************************************

3.01 pl0 Jun. 22, 2002
- COW_SDL_MIXER_BRANCH Jun. 11, 2002
  + add spike solution [tanner]
  + converted local.c to SDL_mixer
  + added cvs commit to mailing list
- minor source packaging changes [cameron]
- mouse wheel support [siegl]

*****************************************************************
2)  Cut and past changes to make COW work like it used to.
*****************************************************************

	none


*****************************************************************
3)  Cut and past changes to turn on *all* new features.
*****************************************************************

3.01 pl0

COW suports now up to 7 Mouse Buttons depending on the OS where the

	mouse wheel up is button 4
	mouse wheel down is button 5

The extra buttons can be configured in the buttonmap with digits

	d e f g   for normal operations
and
	h-s	for shift/control combinations.


****************************************************************
4) New manual sections
****************************************************************

	none

# release process for cow
# emacs: sh-mode

# resolve any differences between working directory and repository

# decide on version number
export VERSION=3.3.1

# update version.h patchlevel.h cow.spec

# update ChangeLog with a release date

# commit
darcs record

# tag release
darcs tag ${VERSION}

# make dist
cd /tmp && \
darcs get ~/src/netrek-client-cow && \
cd netrek-client-cow && \
sh autogen.sh && \
./configure && \
make dist && \
mv netrek-client-cow-${VERSION}.tar.gz ..

cd /tmp
md5sum netrek-client-cow-${VERSION}.tar.gz
b4f686e37b694050e701e4b36f605008  netrek-client-cow-3.3.1.tar.gz

# test build the .tar.gz
cd /tmp
tar xfv netrek-client-cow-${VERSION}.tar.gz
cd netrek-client-cow-${VERSION}
./configure
make
./netrek-client-cow

# release
cd /tmp
cp netrek-client-cow-${VERSION}.tar.gz ~/public_html/external/mine/netrek/
upw
http://quozl.linux.org.au/netrek/

# orion upload
rsync -avP netrek-client-cow-${VERSION}.tar.gz \
    quozl@orion.netrek.org:/var/www/files.netrek.org/COW/

# sf.net upload
rsync -avP netrek-client-cow-${VERSION}.tar.gz quozl@frs.sf.net:uploads/
http://sourceforge.net/projects/netrek