=======
StarSim
=======

:Author: David Handy
:Contact: cpif@handysoftware.com
:Date: January 31, 2005
:Web site: http://www.handysoftware.com/cpif/

.. contents::

Welcome!
========
StarSim is a computer game in which you pilot a starship through the
universe, helping starbases in distress, gathering wisdom and treasures and
fighting off Fuon Invaders.

This game is a companion to the book "Computer Programming is Fun!". It is
meant to serve as an example of what you can do with just the standard
Python programming language and the software that comes with the book

See http://www.handysoftware.com/cpif/ for more information about the book.

Features
========

StarSim can be played on a single computer, or by multiple people on several
computers connected by a network. It has simple 2-dimensional graphics and
in the future will have sound effects. This game is meant to serve as a
programming example as well as entertainment and education.

StarSim is written entirely in Python, and the source code comes with the
game. Look in the directory where StarSim was installed (and its
subdirectories, named "starsim", "starsim/player", "starsim/server", etc.),
in the files with names ending in .py, for the the source code for the game.
You are welcome to use this code, or parts of it, in your own games and
programs.

System Requirements
===================
StarSim runs on Windows 98/XP and Linux and probably most any computer that
can run Python (www.python.org). It will run acceptably well on 350MHz
machines.  If you have a slower machine than that, please give it a try but
I make no promises!

Getting Started
===============

When StarSim is installed, it will put an icon on the desktop titled
"StarSim". Double-click that, and a window titled "StarSim control" will
come up with 3 options:

* Start a single-player game
* Start a multi-player game
* Connect to a multi-player game

If you have no network, or no one else running the game, the single-player
game is the only option that makes sense.

If you have multiple computers on a local area network with the StarSim game
installed, you can try the second or third option. The game can handle at
least four players (I haven't tried more than that yet.)

If you have started a multi-player game, and you want to start another
player window and connect it to that game, then select the third option. It
will ask you if the game is on your computer or a different computer. If it
is on a different computer, it will ask you for the computer name and port
number. Usually you can stick with the default port number (9000). The
computer that started the multi-player game should have a StarSim control
window that shows the computer name and the port number it is running on.

You will be asked what you want to name the game's data file. The default is
"game1.dat". The games are saved a subdirectory of your "My Documents"
folder, called StarSim.

When you have answered the questions, and the game starts, another window
appears titled StarSim. This is the main player window. Press the big green
button to start. It will ask you for your user name. Enter a name that you
are willing to remember, because it is your user ID and you will need to
type it again exactly as you did the first time in order to resume playing a
game that you have saved.

Once you have logged in, you will be assigned a new starship to pilot, or
you will be given your old starship back if you have logged in before.

You can press the F1 key for help. [XXX Some of the commands won't work yet
because the game is not finished!]

Have fun, and check back for new and improved versions every once and a
while. What you see now is just the beginning!

David Handy

