Category : Communication (modem) tools and utilities
Archive   : SW09.ZIP
Filename : COMPLETE.DOC

 
Output of file : COMPLETE.DOC contained in archive : SW09.ZIP
SW v0.9
Documentation
(updated 16 April 1991)



IMPORTANT NOTE
--------------
This documentation is for the SW front end program _only_ - it is not
intended to document the Stellar Warrior(tm) game itself. This
documentation assumes that you have read the Stellar Warrior game
instructions, and are familiar with the commands and terms used in the
game.

For complete instructions on playing Stellar Warrior, type M860;1 or
M861 from any GEnie menu or BB prompt to move to the Stellar Warrior
Instructions menu page. From that page, you can list the Version Notes
(detailing recent changes and additions to the game), print a Command
Summary of all the game's commands, and download the complete Manual
using either a capture buffer or the XMODEM protocol.

The game itself also contains extensive online help. For a complete list
of all commands, type "HEL" (without the quotes) at any prompt. For help
on a special command, type "HEL XXX", where "XXX" is the specific
command you wish to see additional information for (example: "HEL RED").
Additional information is also available by typing "INFO" at any prompt.

Finally, human help _is_ available. You can use the "Feedback to Kesmai"
menu item on page 860 to send a GE Mail message for help. Or, you can
post your question in the Multiplayer Games RoundTable - type "M1045;1"
from any GEnie menu or BB prompt, and then type "SET 32" to access the
Stellar Warrior Category.



OVERVIEW
--------

The SW front end for Kesmai's Stellar Warrior combines the processing
power of your own computer with that of GEnie to provide the ultimate in
multi-player gaming.

The SW program adds multi-color graphics, split-screen text entry and
mouse support to Stellar Warrior game play. By closely linking your
computer with GEnie's, the multiple high-density graphic displays can
actually be drawn and updated faster than the text displays you're
accustomed to. The main display shows the interactive star map and your
own ship's weapons status at all times, while overlay displays show
secondary information (including STAtus, DAMage, SURvey, LIBrary,
PRoVince, BASes, and PRObe STAtus displays). In addition, use of an
optional Microsoft Mouse-compatible pointing device allows you to
display even more information about any star, planet, ship, or base on
the display by simply pointing and clicking.



SETUP
-----

SW.EXE is configured to use the serial port at COM1 (using IRQ4). If
your modem is connected to COM2 (IRQ3), COM3 (IRQ4), or COM4 (IRQ3), you
can modify your copy of SW to use a different COM port by typing "SW #"
(without the quotes) from the DOS command prompt, where "#" is the
number of the COM port you wish to use. You will only need to execute SW
in this fashion _once_ - the program will modify itself to use the
selected COM port from that time on.

You can define up to 40 keyboard macros for use with SW, using the
function keys F1 through F10, alone and in conjunction with Shift,
Control, or Alt. The macros re contained in a file called "SW.MAC",
which should be in the same directory as the SW.EXE program file, and
can be edited with any text editor. If you use your word processor to
edit SW.MAC, make sure that you save the file in "plain vanilla ASCII"
format, without any embedded control codes.

The 40 function keys are placed in the macro file in this order:

normal F1 thru F10
Shifted F1 thru F10
Controled F1 thru F10
Alted F1 thru F10.

Defining all 40 macros will create a 40 line file. However, you do not
have to fill in all 40 if you do not wish. Any additional lines beyond
the first 40 will be ignored.

The following is an example SW.MAC file:

ATDT5343521\r
XXX12345,password\r
M 860;3\r
Att\rAtt\r

This example file defines F1, F2, F3, and F4. Both the '\r' and '\n'
combinations are translated into a Return. The tilde character ('~') is
used to indicate a comment - the tilde and all characters after the
tilde on the same line are ignored (use '\~' to insert the tilde
character itself into a macro).

Here are some additional sample macro lines:

loc ~ lock lasers
tor:loa\r fire and reload
imp ,100\r start impulse engines
ene\r~ search for enemy bases
ran ~ set map range

You will probably want to put a space after commands that end without a
Return (like the "loc" and "ran" examples above), and expect you to
supply a parameter.

Macros work just as if you typed them in manually, and appear in the
local buffer area on the screen. If a macro does not end with a Return
('\r' or '\n') then you will be required to hit Return or add on to it
and hit Return in order to send it. Also, please remember that the
limits of 39 characters per input line in game mode and 79 character per
line in terminal mode (not counting the Return) still apply.

As shipped, the SW.MAC file contains sample macros, which may be used or
changed as you wish. If you do not want to use the macros feature of SW,
simply delete or rename the SW.MAC file.



STARTING SW

-----------

To start the SW program, simply type SW from the DOS command prompt. You
should see the following:

SW v0.9
front end program for Kesmai's STELLAR WARRIOR

Written by J. Weaver Jr.
Copyright (c) 1990, 1991 by J. Weaver Jr.

STELLAR WARRIOR is a registered trademark of Kesmai Corporation

COM: x CD: xxx Mouse: xxx Memory: xxxK Free: xxxK

The bottom line of this display shows you (from left to right) which COM
port SW is currently configured to use, whether or not SW can read the
"carrier detect" signal from your modem (this will be used in a future
version), whether or not SW detected a Microsoft Mouse-compatible
pointing device attached to your system, the total amount of
conventional (DOS) memory in your system, and the amount of conventional
memory free after SW has allocated all the memory it requires.

If an error occurs in starting SW, you will see one of the following
error messages:

"Unsupported graphics adapter (#) - must be VGA or EGA." - you attempted
to start SW on a non-supported graphics adapter. You must have an
EGA or VGA card to use SW.

"COM port not recognized by DOS." - your serial card (usually set to
COM3 or COM4) has not properly initialized itself by placing its
base port address in the BIOS parameter area (segment 0040, address
0000 for COM1, 0002 for COM2, 0004 for COM3, or 0006 for COM4). If
there was no program shipped with your serial card to install this
value, send a GE Mail message to FACTORY with the COM port you are
using and your serial card's base address, and we will return a
DEBUG script to create such a program.

"Cannot allocate enough memory for map buffer." - you do not have enough
conventional (DOS) memory free to use SW. If you are running SW
from within another terminal program or from within some kind of
"shell" program, exit the other program and execute SW directly
from the DOS prompt. If you _still_ get this message, remove or
move to expanded/extended memory any or all device drivers, caches,
buffers, and/or TSR's installed in your system to free up enough
conventional memory to use SW.

"Cannot allocate enough memory for star array." - see previous message.

When any of these messages are displayed, press any key to exit SW.



USING THE KEYBOARD
------------------

The following keys have special functions in SW:

ControlEnd exit program (sends "^Mend^M")
Backspace erase one character from local buffer
Return send local buffer
Tab display map legend
ShiftTab display first 8 characters of all macros
F1 - F10 macros 1 - 10
SF1 - SF10 macros 11 - 20
CF1 - CF10 macros 21 - 30
AF1 - AF10 macros 31 - 40
Delete toggle sound on/off

When Stellar Warrior sends a "confirming" prompt, requiring a yes or no
answer (for example, when warping into hyperspace from within a star
system), all other keyboard input will be blocked until the prompt is
answered. You can press Y or + (either the + on the regular keyboard, or
the one on your numeric keypad) to answer affirmatively, or N, - (again,
either one), or Return or Enter to answer negatively.



TERMINAL MODE
-------------

When you start SW, it is in "terminal mode". In this mode, the top 21
lines of the screen show the last 21 80-character lines received via the
COM port shown on the configuration line, with older lines scrolling off
the top of the screen.

The bottom three lines of the terminal mode screen constitute a local
"type-ahead" buffer. Any alphanumeric characters you type will appear in
this buffer, but will _not_ be sent to the remote system (i.e., GEnie)
until you press Return or Enter. You can use your Backspace key to erase
mistakes in the local buffer. The local buffer is currently limited to
79 characters per line. The last two lines sent via the type-ahead
buffer are also shown, with older lines scrolling off the top of the
local buffer screen area.



ENTERING STELLAR WARRIOR
------------------------

To play Stellar Warrior using the SW program, follow the instructions in
the READ.ME file for logging on to GEnie, moving to the Stellar Warrior
menu page, and entering the game itself.

When you enter Stellar Warrior using SW for the first time, you will see
only a text display (or a very jumbled mess, if you were previously
using a cursor-controlling terminal emulation mode). In order to use
SW's graphic display, type "RED 99" (without the quotes) and press
Return or Enter to tell Stellar Warrior that you are using the SW front
end program. To return to text-mode usage, type one of the text-mode RED
commands (such as "RED 8").



GAME MODE
---------

When you issue the "RED 99" command to Stellar Warrior from in flight
(_not_ from the Radio Room), SW will switch out of terminal mode and
into "game mode".

In game mode, the left side of the screen duplicates the functions of
the terminal mode screen; that is, the top section is a 21-line
scrolling area showing information received from the remote system, and

the bottom section is a 3-line scrolling area featuring a 40-character
local type-ahead buffer. All commands you send to Stellar Warrior using
the SW front end program are in _exactly_ the same format as the
commands you would issue when using any of the text or terminal
emulation modes.



SCROLLING AREA
--------------

Most messages appearing in the scrolling area on the left side of the
screen during Stellar Warrior play are color-coded, as follows:

WHITE Radio messages, text, SEArch result lines
GREEN "Good news" messages
YELLOW "Warning"/informational messages
RED "Bad news" messages
DARK BLUE "SENd" messages from other players
PURPLE SEArch result lines from a probe
LIGHT BLUE Information requested by mouse clicks

Clicking on any blip on the map display (other than the blip for your
own ship) or on any base displayed on the BASES overlay will print a
"sensor line" in the scrolling area on the left side of the screen. The
format of the sensor line is the same as in the non-graphic modes of the
game, except that the actual map or base symbol is shown in place of the
alliance and ship type letter codes.

The white line separating the scrolling area from the local type-ahead
buffer will always contain one of the following messages:

COMMANDS: #
RADIO ROOM - COMMANDS: #
PLANETARY ATTACK IN PROGRESS
SHIP IN DRYDOCK - REPAIRS IN PROGRESS

The number in the COMMANDS messages is the number of commands queued up
for execution by the Stellar Warrior host.



SHIP DISPLAY
------------

The upper section of the right side of the game mode screen is occupied
by the ship display, which shows a continual readout of the vital
operating parameters of your ship. The display is as follows:

a----- c --d-- c -----a
| |
| |
| |
c c
| |
f h g
| |
c c
| |
| --------i-------- |
| |
b----- c --e-- c -----b
--j--

Key:
a = fore shields BLACK = 0%, RED = 1 - 24%, R/Y = 25 - 49%,
YELLOW = 50 - 74%, Y/G = 75 - 99%, GREEN = 100%
b = aft shields BLACK = 0%, RED = 1 - 24%, R/Y = 25 - 49%,
YELLOW = 50 - 74%, Y/G = 75 - 99%, GREEN = 100%
c = torpedo tubes BLACK = disabled, RED = unloaded, GREEN = loaded
d = fore lasers BLACK = 0%, RED = 1 - 24%, R/Y = 25 - 49%,
YELLOW = 50 - 74%, Y/G = 75 - 99%, GREEN = 100%
e = aft lasers BLACK = 0%, RED = 1 - 24%, R/Y = 25 - 49%,
YELLOW = 50 - 74%, Y/G = 75 - 99%, GREEN = 100%
f = fuel RED = 0 - 24%, YELLOW = 25 - 49%, GREEN = 50% +
g = temperature RED = 50% +, YELLOW = 25 - 49%, GREEN = 0 - 24%
h = map area PURPLE border = map information is from a probe
i = map legend
j = current target

For more information on any data item on the ship display, simply point
at the item with the mouse pointer and click either button once. The
information requested will appear in the scrolling area on the left side
of the screen, in the same color as the mouse pointer itself.



MAP DISPLAY
-----------

In the center of the ship display is the map display, showing the area
of space currently occupied by your ship. Each "blip" on the map display
is color-coded as follows:

GREY alliance unknown or disputed
RED Alliance A
YELLOW Alliance B
BLUE Alliance C
GREEN Alliance D
PURPLE neutral (planet) or minor (star)
WHITE star

There is also a different shapes for each _kind_ of blip (ship, missile,
probe, or celestial body) which can appear on the map display. Press Tab
at any time to display a legend of these shapes in the scrolling area of
the screen.

As with the rest of the game display, you can click on any blip on the
map to display to more information about that item in the scrolling area
of the screen (in the same color as the mouse pointer itself).

When you are in a star system, the default map display is the SYSTEM
MAP, showing the star in the center. When you are in space, the default
map display is either the HYPERSPACE MAP (showing your ship in the
center of the display) or the PROVINCE MAP (showing the entire province
you are currently in), depending on which mode (PIC N or PIC P) you have
chosen. The map legend always shows the current map mode, as well as the
range of the map (the distance from the center of the map to any edge).
If the information shown on the map display is from information from a
probe, there will be a PURPLE border around the map area.

Any map display requested _other_ than the default map mode (for
example, a "MAP P" or "MAP" display, or "PRO PIC" or "PRO LIB") is
temporarily laid over the default display. To restore the default
display, simply press Return or Enter.


Typing "MAP" displays the capitals map, a map of the entire galaxy
showing the four alliance capitals, in their respective colors. If a
star number is added to the command (i.e., "MAP 1234"), that star is
also displayed, in WHITE. Clicking on any of the stars displays
information about that star; clicking on any province in the map grid
displays the name of that province in the scrolling area, and
automatically generates the PROVINCE overlay for that province in the
overlay area of the screen.

Typing "MAP" when in the Radio Room displays the tactical map, a similar
map of the entire galaxy, but showing instead the current status
(aligned or disputed) of all 144 provinces. As with the capitals map,
clicking on any province in the map grid displays the name of that
province in the scrolling area, and automatically generates the PROVINCE
overlay for that province in the overlay area of the screen.



OVERLAY AREA
------------

The lower section of the right side of the screen (beneath the ship
display) is occupied by one of the informational "overlays" described
below. The default overlay area display is the instrument panel,
described first; any other overlay you request is temporarily laid over
the default display. Just as with the map display, press Return or Enter
to restore the default display.



INSTRUMENT PANEL (the default display)
--------------------------------------

HEADING -- DRIVE: ### VELOCITY: ##### ORDERED: #####
##### / \ -------------------------------------------
ORDERED \ / -------------------------------------------
##### -- xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

From upper left across: heading, heading compass, drive type, velocity,
ordered velocity, velocity bar graph, heading ordered, position text.

Bar graph: GREEN bar shows current velocity, YELLOW bar shows ordered
velocity (RED if greater than current maximum value), with BLACK fill to
current maximum value.



STATUS OVERLAY (type "STA")
---------------------------

SHIP: #### ALL.: # RADIO FIGHTERS: ### S: #### PROBES: ###
HULLS: ## VICTS: ## ### TORPEDOES: ### F: #### H: ####
SCORE: ######### ### MISSILES: ### F: #### H: #### P: ####
UNREP: ######### ### LASERS F: #### H: #### P: ####

From upper left across: ship, alliance, fighters on board, fighter
sorties launched, probes on board, hulls, victories, radio channel A,
torpedoes on board, torpedoes fired, torpedo hits, score, radio channel
B, missiles on board, missiles fired, missile hits, planet missile hits,
unreported score, radio channel C, lasers fired, laser hits, planet
laser hits.

This overlay is automatically generated when you enter Stellar Warrior,
and by several other commands (including "RED 99" and "DRY").



DAMAGE OVERLAY (type "DAM")
---------------------------

#### ---------------------- SHIELDS ---------------------- ####
#### ---------------------- LASERS ---------------------- ####
#### ---------------------- SPEED ---------------------- ####
F STRENGTH: #### SCOOP: #### HULL ---------------------- ####

From upper left across: fore shields, fore shields bar graph, aft
shields bar graph, aft shields, fore lasers, fore lasers bar graph, aft
lasers bar graph, aft lasers, maximum warp, maximum warp bar graph,
maximum impulse bar graph, maximum impulse, fighter strength, scoop
status, hull percentage bar graph, hull percentage.

Bar graphs: GREEN bar shows current level, with RED fill to maximum
value.



PROVINCE OVERLAY (type "PRV")
-----------------------------

QUADRANT: # PROVINCE: ## +---+ MAJOR BASES
CAPITAL STAR: ###### | | A: ## B: ## C: ## D: ##
CURRENTLY OWNED BY: # | | TOTAL BASES
PREVIOUSLY OWNED BY: # +---+ A: ## B: ## C: ## D: ##

From upper left across: quadrant, province, galaxy map, capital star and
planet, major bases owned by A, major bases owned by B, major bases
owned by C, major bases owned by D, current owner of province, previous
owner of province, total bases owned by A, total bases owned by B, total
bases owned by C, total bases owned by D.

Galaxy map: WHITE block indicates province selected. PURPLE border on
overlay indicates information is from a probe.

This overlay is also generated by clicking on a province in the map grid
of either the capitals map (type "MAP") or the tactical map ("MAP" from
the Radio Room).



PROBE STATUS OVERLAY (type "PRO STA")
-------------------------------------

--

HEADING / \ xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
##### \ / PROBE VELOCITY: ##### PROBE ENERGY: #####
--

From upper left across: heading, heading compass, probe status/location
text, probe velocity, probe fuel.



SURVEY OVERLAY (type "SUR" or "PRO SUR")
----------------------------------------


STAR: #### PLANET: # ALL.: # HABIT. ---------------------- ####
POPULATION: ######### METALS ---------------------- ####
DEFENSE: ######### MAX. REPAIR ---------------------- ####
VALUE: ######### LAST CAPTURE ---------------------- ####

From upper left across: star, planet, alliance, habitability percentage
bar graph, habitability percentage, population, metals percentage bar
graph, metals percentage, defense, repair bar graph, repair, value, last
captured bar graph, last captured.

Bar graphs: GREEN bar shows current level, with RED fill to maximum
value. PURPLE border on overlay indicates information is from a probe.


LIBRARY OVERLAY (type "LIB" or "PRO LIB")
-----------------------------------------

LIBRARY MASS A #### B #### C #### D #### E #### F ####
S: #### TEMP #### #### #### #### #### ####
I: #### ORBIT ###### ###### ###### ###### ###### ######
PL'S: # PRESS ###### ###### ###### ###### ###### ######

From upper left across: planet A mass, planet B mass, planet C mass,
planet D mass, planet E mass, planet F mass, star number, planet A
temperature, planet B temperature, planet C temperature, planet D
temperature, planet E temperature, planet F temperature, star intensity,
star A orbit, star B orbit, star C orbit, star D orbit, star E orbit,
star F orbit, number of planets, planet A pressure, planet B pressure,
planet C pressure, planet D pressure, planet E pressure, planet F
pressure.

PURPLE border on overlay indicates information is from a probe.



BASES OVERLAY (type "BAS", "ENE", "PRO BAS", or "PRO ENE")
----------------------------------------------------------

# ####.# # ####.# # ####.# # ####.# # ####.# # ####.#
BASE # ####.# # ####.# # ####.# # ####.# # ####.# # ####.#
SCAN # ####.# # ####.# # ####.# # ####.# # ####.# # ####.#
# ####.# # ####.# # ####.# # ####.# # ####.# # ####.#

From upper left across: alliance, star, planet (x 24).

Click on any base displayed on the overlay for range and heading
information (displayed in the scrolling area on the left side of the
screen, in the same color as the mouse pointer. Bases are sorted by
distance from scan origin (nearest first). PURPLE border on overlay
indicates information is from a probe.



ERROR MESSAGES
--------------

You may occasionally see a message in LIGHT GREY text in the scrolling
area that looks something like this:

*** Invalid packet # received
Field # = #, #, #, #

This message, which may or may not be followed by a few "garbage"
characters, indicates that one "packet" (between 8 and 78 bytes) of
information was received incorrectly by SW. The _usual_ cause for this
message is line noise - one or more of the bytes in the packet was
garbled, so that the packet checksum (designed to prevent bogus
information from being displayed on your screen) did not match the
checksum received from GEnie. If your last command to Stellar Warrior
was requesting information (such as a new map display or a STAtus
overlay), it may have to be repeated.

If you receive _many_ such error messages, and/or several "Command not
recognized!" messages, your current connection to GEnie is too noisy for
proper use of SW - hang up and redial. If noise conditions persist, type
"PORT" (without the quotes) at any GEnie menu prompt, note the numbers
given, and then type "FEEDBACK" and include those numbers and the local
phone number you dialed in your message describing the line noise
problems you've encountered.

If the error messages you receive _always_ contain the same packet
number, or if you notice that you _always_ receive an invalid packet
after entering some specific command or performing some specific action,
you may have found a "bug" in either Stellar Warrior or SW. Please use
the "Feedback to Kesmai" item on the Stellar Warrior menu page, and give
us the _exact_ text of the error messages, along with the _exact_ text
of any commands that generate them.



COMMENTS? SUGGESTIONS?
----------------------

Please send us your comments and suggestions (as well as any bug
reports) by selecting the "Feedback to Kesmai" item on the Stellar
Warrior menu page, or by leaving a message in the Stellar Warrior
Category in the Multiplayer Games RoundTable ("M1045" from any GEnie
prompt). Thank you for playing Stellar Warrior!



Stellar Warrior is a registered trademark of Kesmai Corporation
Stellar Warrior is Copyright (c) 1991 by Kesmai Corporation

SW is Copyright (c) 1990, 1991 by J. Weaver Jr.
The SW Documentation is Copyright (c) 1990, 1991 by J. Weaver Jr.


  3 Responses to “Category : Communication (modem) tools and utilities
Archive   : SW09.ZIP
Filename : COMPLETE.DOC

  1. Very nice! Thank you for this wonderful archive. I wonder why I found it only now. Long live the BBS file archives!

  2. This is so awesome! 😀 I’d be cool if you could download an entire archive of this at once, though.

  3. But one thing that puzzles me is the “mtswslnkmcjklsdlsbdmMICROSOFT” string. There is an article about it here. It is definitely worth a read: http://www.os2museum.com/wp/mtswslnk/