TradeWars 2002 Assistant Help Text

From TradeWars Museum

Revision as of 22:53, 28 April 2010 by Jpritch (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search
.----------------------------------------------------------------------------.
! Table of Contents  !
`----------------------------------------------------------------------------'


1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2 Disclaimer . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.3 Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 6
1.4 Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.5 Compatibility . . . . . . . . . . . . . . . . . . . . . . . 7
1.6 Files . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.7 Support and Distribution . . . . . . . . . . . . . . . . . . 9
1.8 Licensing and Registration . . . . . . . . . . . . . . . . . 10


2 Command Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 11


3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . 12

3.1 Creating a database . . . . . . . . . . . . . . . . . . . . 12
3.2 Using the menu . . . . . . . . . . . . . . . . . . . . . . . 12
3.3 Saving/printing reports . . . . . . . . . . . . . . . . . . 12
3.4 Prompts and defaults . . . . . . . . . . . . . . . . . . . . 13
3.5 Misc. info . . . . . . . . . . . . . . . . . . . . . . . . . 13


4 Report Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . 14


5 (M)odify database menu . . . . . . . . . . . . . . . . . . . . . . 15

5.1 (E)xtract data from a capture file . . . . . . . . . . . . . 15
5.2 (A)voids . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.3 (B)usted . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.4 (F)ighters . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.5 (M)ines . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.6 (L)impets . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.7 (P)orts . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5.8 (W)arps . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5.9 (N)otes . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.10 (G)ame information . . . . . . . . . . . . . . . . . . . . . 20
5.11 (S)hip information . . . . . . . . . . . . . . . . . . . . . 21
5.12 Merge another (T)rader's database . . . . . . . . . . . . . 22
5.13 Strip database for (O)ther trader . . . . . . . . . . . . . 23


6 (D)atabase summary . . . . . . . . . . . . . . . . . . . . . . . . 24







Page 2


Table of Contents (contd)


7 (N)otes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

7.1 (V)iew notes . . . . . . . . . . . . . . . . . . . . . . . . 25
7.2 (E)dit notes . . . . . . . . . . . . . . . . . . . . . . . . 25
7.3 (S)earch notes <Registered only> . . . . . . . . . . . . . 25


8 (A)sset Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 26

8.1 (F)ighter deployments . . . . . . . . . . . . . . . . . . . 26
8.2 (M)ine deployments . . . . . . . . . . . . . . . . . . . . . 26
8.3 (L)impet deployments . . . . . . . . . . . . . . . . . . . . 26
8.4 (A)ctive Limpets . . . . . . . . . . . . . . . . . . . . . . 26


9 (P)ort Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 27

9.1 (P)aired ports . . . . . . . . . . . . . . . . . . . . . . . 27
9.2 (N)earest ports . . . . . . . . . . . . . . . . . . . . . . 27
9.3 (U)known status ports . . . . . . . . . . . . . . . . . . . 28
9.4 (B)usted ports . . . . . . . . . . . . . . . . . . . . . . . 28
9.5 (0) Closest place to buy class 0 items . . . . . . . . . . . 28
9.6 (L)ikely major port locations . . . . . . . . . . . . . . . 29


10 (S)ector Report . . . . . . . . . . . . . . . . . . . . . . . . . . 30

10.1 (F)ull report on a sector . . . . . . . . . . . . . . . . . 30
10.2 (N)earest sectors . . . . . . . . . . . . . . . . . . . . . 30
10.3 (U)nexplored sectors . . . . . . . . . . . . . . . . . . . . 30
10.4 Une(x)plored clusters <Registered only> . . . . . . . . . 31
10.5 Un(k)nown sectors <Registered only> . . . . . . . . . . . 31
10.6 (W)ithout warps <Registered only> . . . . . . . . . . . . 32
10.7 A(v)oids . . . . . . . . . . . . . . . . . . . . . . . . . . 32
10.8 (D)end end sector analysis . . . . . . . . . . . . . . . . . 32
10.9 DE distances to (M)ajor ports <Registered only> . . . . . . 33
10.10 (C)luster dead end analysis <Registered only> . . . . . . 33
10.11 (S)ecluded area analysis <Registered only> . . . . . . . . 34


11 (R)oute Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 35

11.1 (N)ormal route . . . . . . . . . . . . . . . . . . . . . . . 35
11.2 (T)ranswarp route . . . . . . . . . . . . . . . . . . . . . 35
11.3 (S)pace lanes . . . . . . . . . . . . . . . . . . . . . . . 35
11.4 (M)ap universe routes . . . . . . . . . . . . . . . . . . . 36
11.5 (A)nalyze warps . . . . . . . . . . . . . . . . . . . . . . 38







Page 3


Table of Contents (contd)


12 (C)ustom Reports <Registered only> . . . . . . . . . . . . . . . 39

12.1 (C)opy a report <Registered only> . . . . . . . . . . . . . 39
12.2 (D)isplay a report <Registered only> . . . . . . . . . . . 39
12.3 (E)xecute a report <Registered only> . . . . . . . . . . . 40
12.4 (M)odify a report <Registered only> . . . . . . . . . . . . 40
12.5 (R)ead reports from another file <Registered only> . . . . 40


13 (G)raphic Displays . . . . . . . . . . . . . . . . . . . . . . . . 41

13.1 Display around a (S)ector . . . . . . . . . . . . . . . . . 41
13.2 Display along a (R)oute <Registered only> . . . . . . . . 41


14 ($) Registration and configuration . . . . . . . . . . . . . . . . 42

14.1 Registration (N)ame . . . . . . . . . . . . . . . . . . . . 42
14.2 Registration (C)ode . . . . . . . . . . . . . . . . . . . . 42
14.3 (D)ESQview lines . . . . . . . . . . . . . . . . . . . . . . 42
14.4 (H)ot keys . . . . . . . . . . . . . . . . . . . . . . . . . 43
14.5 (S)creen writes . . . . . . . . . . . . . . . . . . . . . . 43
14.6 (V)ideo driver . . . . . . . . . . . . . . . . . . . . . . . 43
14.7 (L)og file mode . . . . . . . . . . . . . . . . . . . . . . 44


15 Multitasking Environments . . . . . . . . . . . . . . . . . . . . . 45

15.1 DESQview . . . . . . . . . . . . . . . . . . . . . . . . . . 45


16 Automode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

16.1 Important notes about automode . . . . . . . . . . . . . . . 47
16.2 Automode commands . . . . . . . . . . . . . . . . . . . . . 48
16.3 Automode examples . . . . . . . . . . . . . . . . . . . . . 50


















Page 4


.----------------------------------------------------------------------------.
! Section 1 Introduction  !
`----------------------------------------------------------------------------'

Every good trader needs an assistant. The assistant keeps records and
provides information so the trader can make better decisions. Trade Wars
2002 (TW2002) is a bulletin board door game by Martech Software, Inc. The
game has a lot of different aspects and keeping track of all the details by
hand can be quite tough. I looked at utilities to help me with the game
but could not find one that met my needs or the needs of my friends, so I
decided to build one from scratch. Trade Wars 2002 Assistant (TWASSIST)
was born. After nine months of continuous work (with only a few sanity
breaks) version 1.0 was ready and released on October 12th, 1992. Version
2.3 was released on December 2, 1995.

Hopefully you will find TWASSIST user friendly and intuitive to use. This
document will explain how to get started and what each of the functions do.
Included in some areas are tips on how the information can be used to help
you play the game.

As with all off-line utilities of this type, they can only tell you about
the universe as you know it. Examples are routes and distances which can
only be plotted through sectors you have warp information for, as opposed to
the Federation Navigation System in the game that knows the entire universe
and can plot courses through any sector. As a result, distances and routes
with the utility may be longer than those reported in the game. They will
never be shorter. The more of the universe you have information on, the
better the utility will match the game and the more information it can
provide in the various reports.


XXXX 1.1 XXXX Features

NOTE: Some features are available only to registered users.

An intuitive menu structure is used to access various functions.

The doc provides information on how to use a number of the reports in
the game.

Create your own custom reports.

Reports will use the entire screen if running in 43 or 50 line mode.

Data is easily read from a capture file plus the capability to make
manual modifications.

Easy to merge data from playing partners. Your known data is
distinguished from merged data.

An efficient no turn universe mapper to gather the warps for the entire
universe without exploring it.

Automode provides a way of accessing TWASSIST from macros for your
communications program.


Page 5


1.1 Features (contd)


Error and warning messages are in English, with any DOS message (if
applicable) added on.

Backup data files are automatically provided.

DESQview aware. CPU time is given up while waiting for input.

Supports hot keys. User selectable.


XXXX 1.2 XXXX Disclaimer

The TWASSIST package is provided AS IS. Sasquatch Software makes no
warranty, either expressed or implied, with respect to the software or
documentation, including but not limited to their quality, performance,
merchantability, or fitness for a particular purpose. In no event will
Sasquatch Software or the author be liable for direct, indirect, special,
incidental, or consequential damages arising out of the use, misuse, or
inability to use the software or documentation, even if advised of the
possibility of such damages.


XXXX 1.3 XXXX Acknowledgements

I would like to give thanks to Gary and Mary Ann Martin of Martech
Software, Inc. for the game, Trade Wars 2002. It has provided me with
hours upon hours of entertainment and excitement.

I would also like to acknowledge my beta testers, Dan Roseen and Casey
Stemp, for providing invaluable help in the initial release of this program
by discussing ideas and working out the bugs.

Thanks to the many macro writers for their past or present contributions
of scripts to be distributed with TWASSIST: Casey Stemp, Dan Roseen,
Jason Jiggens, Stephen Whitis, and Mark Cothran.

Dan Roseen deserves special recognition. He is a good friend and got me
interested in TW2002. He convinced me of the need to develop TWASSIST and
inspired me to keep going when my morale was low and provides continuing
encouragement.


XXXX 1.4 XXXX Trademarks

DESQview is a trademark of Quarterdeck Office Systems.
IBM is a trademark of International Business Machines Corporation.
MS-DOS is a registered trademark of Microsoft Corporation.
QEMM-386 is a trademark of Quarterdeck Office Systems.
Windows is a trademark of Microsoft Corporation.





Page 6


XXXX 1.5 XXXX Compatibility

Trade Wars 2002:

This program has been tested for compatibility with TW2002 door versions
v1.03(d) and v2 beta 8, and the Major BBS version 2. Compatibility with
other versions or modified games is not guaranteed.

Operating system:

TWASSIST runs on an IBM or 100% compatible PC or AT running DOS. It
has been tested under MS-DOS versions 5.0 and 6.2. Compatibility with
other versions or operating systems is not guaranteed.

TWASSIST can be run in a window under DESQview. It has been tested
under v2.26 on a 80286 PC and v2.42 on a 80386 PC. It has also been
tested with QEMM-386 version 6.02. For more information see the
section Multitasking Environments near the end of this document.

RAM:

TWASSIST allocates memory for some things as it is needed. As a result
your memory requirements may be different than someone else's. It will
also vary according to universe size. The minimum memory required for a
1000 sector universe is around 250k bytes. For a 5000 sector universe it
is around 500k bytes. Notes will increase the amount of memory required.

If expanded memory is available TWASSIST will load the overlay part of
the program into EMS. EMS is not required but is recommended. Less than
100k of EMS would be used.

Disk:

A hard disk is recommended, especially if you have multiple games. It
is possible to run from a floppy based system. Refer to the section on
files for information on file sizes.

NOTE: Starting with version 2.1 TWASSIST uses overlays for part of the
program. If you don't have enough Expanded memory (EMS) the
overlays will be loaded from disk as needed. If you are running
from floppy you should not remove the disk with the TWASSIST
program while it is running.

Video:

The graphic displays require VGA 640x480 or EGA/VGA 640x350 graphics.
All other parts of the program display standard text. TWASSIST detects
the number of lines and will use all lines when displaying reports.
Testing has been done using color monitors. Compatibility with
monochrome monitors is unknown.







Page 7


XXXX 1.6 XXXX Files

The original TWASSIST version 2.2 package distributed from Sasquatch
Software was compressed using PKZIP with authenticity verification. When
the archive is uncompressed each file should have a "-AV" flag and a
message at the end indicating authentic files were verified that looks like
this:

Authentic files Verified! # CHE892
Sasquatch Software

If you do not see the -AV and the message it is not the original archive.
It has been rearchived by someone and may or may not be a good package.

The TWASSIST version 2.3 package (TWAST23.ZIP) contains the following
files:

FILE_ID .DIZ 540 12-02-95 2:30a File Id/description
TWASSIST.DOC 124,784 12-02-95 2:30a This document
TWASSIST.EXE 259,232 12-02-95 2:30a The executable program
TWASSIST.HIS 21,031 12-02-95 2:30a History information
TWASSIST.REG 4,602 12-02-95 2:30a Registration request form
TWASTMAC.DOC 39,016 12-02-95 2:30a Com. program macros document
TWASTMAC.ZIP 24,431 12-02-95 2:30a Com. program macros

Files created by the program:

TWASSIST.CFG Configuration file. This file is created in the same
directory the program is located in. Size is 256 bytes.

TWASSIST.CFK Backup of the configuration file.

game.DAT The database file of game information. Each game will
have a separate database file. The 'game' part of the
name is chosen by the user. File size will depend on the
size of the universe and the number of notes. For a 1000
sector universe the size can vary from 40k to 160k
depending on the amount of notes. A 5000 sector universe
will start at 200k and can go much higher with notes
(limited by the amount of conventional memory in your
computer).

game.BAK Backup of the database file.

game.CIM File of route commands to be sent to the game while using
the universe mapper.

game.CUS Custom reports file. Size is 604 bytes.

game.CUK Backup of the custom reports file.

game.LOG A log file of the messages while extracting from a capture
file or merging another traders database. This is useful
if you want to go back and check on some errors or other
info.


Page 8


1.6 Files (contd)


game.RPT The default name used for the report file. The actual
name is chosen during runtime. It can be anything,
except for some reserved extensions shown in this list.
More than one report file can be used by providing
different names. Sizes will vary.


XXXX 1.7 XXXX Support and Distribution

Updates and/or new releases of TWASSIST can be downloaded or file
requested from the support BBS identified below. If you are logging in,
you will have to fill out a new user questionnaire. Once you have done
this you will have enough access to download TWASSIST without complete
user verification. Enter messages in the Private E-mail conference or
send a Comment to Sysop.

If you are experiencing problems, call the BBS or write and include the
following information:

þ A detailed explanation of the problem.
þ The game files: game.DAT and, if you have one, game.CUS
þ Configuration file: TWASSIST.CFG (from the program directory)

Mail can be sent to:

Sasquatch Software
P.O. Box 4331
Kent, WA 98032-9331

Support and Distribution:
-------------------------

Sysop: Albin Gersich

BBS: The Harry Beast

Login: (206)859-6157 Kent, WA - USA
23 hrs (Mail hour 1-2AM PST or 2-3AM PDT)
14.4k V.32bis/V.42bis

Fidonet: 1:343/102
Internet: albin.gersich@f102.n343.z1.fidonet.org

Comment: For downloading latest version: Download TWAST*.ZIP
For file-requesting: Use the magic name "TWASSIST"
or request TWAST*.ZIP








Page 9


XXXX 1.8 XXXX Licensing and Registration

The software and documentation is copyrighted and is protected by United
States copyright laws and international treaty provisions. All rights
are reserved by Sasquatch Software. The software is owned by Sasquatch
Software and title remains in Sasquatch Software. You may distribute
unregistered versions of the program as long as the entire package (as
described in the section titled Files) is distributed together and no fee
is charged for the software (a nominal distribution or shipping fee is ok).
Distribution of registration codes, methods of defeating the registration
mechanism, or modified files is illegal. Distribute the package as it was
released. Do not add, delete, or modify files. You may not decompile,
disassemble, modify, merge, or reverse engineer the software in any way.

A registration fee is required to use all the features of TWASSIST.
There are a lot of unregistered features so you can get a feel for the
program before you decide to register. If you purchase a registration code
you will be granted a license to use all the features of TWASSIST. If you
decide not to register you are granted a license to continue to use the
unregistered features of TWASSIST. The registered only menu items will
have the text "<Registered only>" on the right. You will not be able to
select these menu items. If the program is registered the registered only
text will be removed from the menu.

Registration is a one time fee. Once you register it will be good for
all future versions of this program. One registration may be used by all
members of a household but it may be used on only one computer at a time.
If it is to be used by multiple people on multiple computers a registration
is required for each. Registrations are not transferable.

The registration price is US$15. Sales tax for residents of Washington
state will be paid by Sasquatch Software. For my good friends to the north
I will accept Canadian dollars or they may pay in U.S. dollars. The price
in Canadian dollars is C$19. Residents outside the United States and
Canada must pay in U.S. dollars.

Those who do not want to register, but wish to provide incentive for the
development of utilities, may contribute in any amount they desire. Print
out the registration order form, follow its instructions, and fill in the
blank for the amount of the contribution.

Please send a check or money order in U.S. (or Canadian) funds. If
payment is made by personal check the registration code will not be sent
until the check clears. Personal checks will only be accepted if they are
drawn on U.S. or Canadian banks. Residents outside the U.S. and Canada may
pay using a bank check with funds drawn on a U.S. bank or using an
international money order denominated in U.S. funds. Cash is discouraged.
The sender takes all responsibility for the payment reaching Sasquatch
Software. Print the registration order form, TWASSIST.REG, fill it out and
follow the instructions on the form. Please allow up to four weeks (longer
outside the U.S. and Canada) for delivery of your registration code.






Page 10


.----------------------------------------------------------------------------.
! Section 2 Command Arguments  !
`----------------------------------------------------------------------------'

TWASSIST will accept various parameters and options on the command line.
You do not have to provide any. If you run TWASSIST without any arguments
it will prompt for the database (game) name.

Legend:

[] Brackets represent an optional item.

UPPER Upper case letters must be typed exactly (although you may
use upper or lower case letters).

lower Lower case letters represent a parameter you provide a value
for.

... Ellipsis mean the previous item may be repeated. You can
provide multiple values by separating each with a space.

Format:

TWASSIST [database[.DAT] [/A[,cmd_file
Personal tools
current TWGS Activity
Servers:
currently active: 169
since 2011: 12,077
Players:
this month: 333
this year: 3,065
last year: 2,983
since 2011: 64,762