This is the README/FAQ file for the sc4map program.

WHAT IS SC4MAP?
---------------

sc4map is a perl script to convert saved sc4 turn reports into a nice
graphical map. 


REQUIREMENTS
------------

It's a perl script, so you need to have perl installed.  On Unix, this
shouldn't be a problem.  On windows, you can download perl from ActiveState's
website (http://www.activestate.com).

You also need to have ghostview or some other postscript printer/viewer.
You probably already have this installed. You can download it from:
http://www.cs.wisc.edu/~ghost/

FILES
------------

README		this file
README.bat 	windows program to view the README file
makemap.bat	windows program to automatically make a simple map
maphelp.bat	windows program to display options for sc4map
sc4map		the actual program
sc4map.conf	the configuration file.
turns/jan2750	a sample turn report.  Make yours look like this one.


USAGE
-----------

sc4map expects to find your turn reports in a subdirectory called 'turns'.
Each turn report should be named like so:

jan2750
feb2750
mar2750
.
.

Alternately, you could name them all things like:

2750.1
2750.2
2750.3
.
.

You can also have a file extension, eg)  jan2750.txt.

You MUST use the same naming scheme for ALL of the turn files in the turns
directory, or data will be out of order.

NOTE for MS Outlook:  to save messages from Outlook into a format that
sc4map understands, use:   File -> SaveAs -> messages;   then choose "DOS
Text" as the file type.

You will need to edit the sc4map.conf file so that your empire acronym
shows up properly. It's really easy.  You may also want to play with the
colors defined there.

Assuming you've got everything else set up, you should be able to type
on the command line:

In *nix:
	sc4map [options] > outputfile.ps

In a DOS window:
	perl sc4map [options] > outputfile.ps

Or, in windows, you can click on MAKEMAP.BAT, which will make a map
called curturn.ps.  This doesn't let you use different options, but hey.


sc4map supports the following options:

options:
-Z		make bigger;  A4 size paper, rather than 8.5x11.
-m <month>	show map for given month, default is most recent.(use full path)
-t <ship>	show trail for specified ship
-T  		show trails for all ships
-M		only show Most recent ship movements(with -s or -S)
-l		label planets
-L 		label ships 
-a		label by empire acronym.
-A		label by ship type. (corvette, etc)
-e  		apply actions to enemy empires as well
-E 		apply actions to enemy empires ONLY.
-x		show explored parts of the map. (approx)
-c <file>	use specified config file instead of sc4map.conf
-s		show scan radii
-S 		show supply radii
-v		show version and exit.
-h		show this help.

So, an example usage would be:

	sc4map -Le > mar2750.ps

Or, in a DOS window:
	perl sc4map -Le > mar2750.ps

you can then open mar2750.ps in ghostview.

BUGS
-----------

Yes, there are bugs.  One big thing is that BGs aren't specifically 
supported. I have no idea what will happen when you've got them.  

Since Matt changed the turn format, a lot of things may not work. As
of version 2.3, sensor contacts are wierd.  Only enemy planets are parsed,
and enemy ship trails will not be represented before April 2750.  this
should be a minor inconvenience.

email me with other bugs.  (sc4@jess2.net)


QUESTIONS
--------------

1) what do all the symbols mean?

I plan to put up some sort of webpage in the near future; until then,
you'll have to figure it out yourself. :/  Triangles are ships, circles
are planets. 



END
--------------