
                   W�ms of Prey - WoP v0.4.1 (2006-02-08)


About
################################################################################

WoP is another multi-player, real-time clone of Worms just like Liero and NiL.
You control a little worm and try to score as many frags as possible by
shooting other worms or scoring goals. Just give it a try, you will love it.
You can find screenshots and videos on http://wormsofprey.org/ .


Requirements & Installation
################################################################################

You have the choice to use a precompiled binary or the source package.
In either case you also need the data package. All of this can be downloaded
from http://wormsofprey.org/ which you most likely already did.

If you want to compile WoP yourself you need up-to-date versions of the SDL and
associated libraries. We currently use the following versions:

  SDL       >= 1.2
  SDL_net   >= 1.2.5
  SDL_image >= 1.2
  SDL_mixer >= 1.2
  SDL_ttf   >= 2.0

WoP might compile and work flawlessly with older or newer versions. Please give
us some feedback about your experience with different versions.

For compilation simply type 'make' in the src directory. You can move the
executable wherever you want. The same is true for the data package.

When starting WoP you have to specify where to find the data directory.
This can either be done by adding the option 'data=/homes/tom/wop/data'
or by adding the same line to the file ~/.woprc (which can be done with
any option).

The WoP version, the compiler, and the used compiler options should be
absolutely the same for the server and all connected clients. Otherwise the
clients will lose synchronization pretty quickly and the server will stop the
game. The simplest way to ensure this is to use the same executable.


Game Play
################################################################################

For playing WoP you need both a server and a client. To start a server (client)
run WoP with the option 'mode=server' ('mode=client'). When starting a server,
it is advisable to specify the option 'quiet=yes' otherwise you will be hearing
the game sounds in the server process, too. A complete list of all options with
a brief description is printed when running WoP as 'wop -help'.

You control your worm with the following keys:

cursor left  - turn and walk left
cursor right - turn and walk right
cursor up    - aim up
cursor down  - aim down
left shift   - jump/jetpack
left control - shoot weapon
left alt     - dig earth
1 ... 0      - choose weapon (we let you figure out which weapon does what)
c, v         - cycle through weapons (backward, forward)
z (or y)     - shoot rope (use option 'keyboard=de' for using y instead of z)
x            - cut rope
a            - decrease length of rope(s)
s            - increase length of rope(s)
d            - release rope
tab          - show scores
return       - enter chat mode (type message and press return again to send)
space        - spawn another worm after dying
o            - save screenshot
t            - toogle window/fullscreen view
esc          - quit game

You can also alter this default keyboard layout in the game menu
(Options->Configure Keys) and store your current settings (Options->Save
configuration). But be aware that this option overwrites your personal
configurations.

The overall goal of WoP is to have fun. A secondary goal can be to have more
frags than other players. You gain a frag by shooting another player, you
lose one by killing yourself. Another way to earn five frags is to drag the
ball (which is indestructible, by the way) inside the goal (marked with a
red circle) and to keep it there for two seconds attached to your rope(s).
If the ball is attached to ropes of different players, nobody can score. If
a player places the ball in the goal attached by another player's rope, the
owner of the rope get the frags. Describing it is more confusing than actually
playing it... :-)

Hint: The rope can be attached to any object including weapons. There is also
one special weapon which only works in combination with ropes...

Per default the game type is a 'deathmatch' where every player is shooting at
everything that is moving. If you start the server with the option
'gamemode=teamplay', players can gather in teams. Every player has to specify
its team number, either by telling e.g. 'team=1' on command line or by
setting the team number in the option dialog. In team mode, all game stats
are counted collectively for each team.

Have a look a the different boni you can collect:
   - health (red cross)              recovers your worm
   - fuel (grey barrel)              reloads your jetpack
   - invulnerability (blue shield)   protects you from any damage
   - invisibility (red shield)       hides you from being seen by other players,
                                     but only you! So be careful when using your
                                     jetpack or ropes...
   - homing missile virus (chip)     disturbs hostile homing missiles


Replay a game
################################################################################

You can store a complete recording of a game if you use the option 'replaylog'
when starting a server (e.g. 'wop mode=server replaylog=wopreplay.dat'). After
the game you can review the played game if you start the executable like this:
'wop mode=replay replaylog=wopreplay.dat'. You can scroll over the map just by
dragging it with the mouse. Besides the provided mouse buttons, you can control
the replayer with the following keys:

space - pause/play
b     - step single frame
m     - slower replay speed
n     - faster replay speed
k     - skip next 1000 frames
s     - save screenshot
t     - toggle fullscreen

Like in the game, each second in the replay consists of 25 frames. Another cool
feature is the ability to set bookmarks so you can jump to your favourite scenes
easily. During the game, pressing F11 stores a bookmark in the replay. In the
replayer you can make use of the bookmarks with these keys:

p     - Jump to the next bookmark (in fact the replayer jumps not directly to
        the bookmark itself but stops 200 frames or 8 seconds earlier so you
        do not have to hurry to press F11 during the game)
o     - Go back to the previous bookmark (note that you can not rewind back any
        further)

And last but not least, if you want to create a movie from your replay you might
find the 'q' key helpful. Pressing it will store 200 consecutive frames as
images as well as the game sound (raw format, signed 16 bit PCM, little endian,
stereo, 22050 Hz) in the current directory. With tools for making movies you can
combine these together.


New Features
################################################################################

v0.4.1:
* Show frames per second with 'F9'
* Toggle frame limiter with 'F8'

v0.4.0:
* Pressing 't' toggles window/fullscreen view
* New command line option "bots". Currently, there are only two
  types of bots available: tombot, scusibot
  Example: 'wop bots=tombot,scusibot'
* Pressing 'F10' focuses the viewport on another player. This is only
  possible if you died and have not yet respawned.
* In some themes stationary guns are waiting for you. Just hop inside
  and shoot. A random weapon is selected each time you enter the gun.


Known Bugs
################################################################################

* If you have trouble playing with fullscreen on Windows (either starting the
  client in fullscreen mode or switching to it), you might try to resolve this
  by inserting the following line at the beginning of the file wop_client.bat:
    set SDL_VIDEODRIVER=windib
* The sound on Windows platforms may sound choppy and noisy. This is due to
  the SDL sound implementation and unfortunately only a new release of the SDL
  library might resolve this problem.

Send us a mail if you have found a bug (include information about the WoP
version you used, your system, and the log).


Copying & License
################################################################################

WoP is distributed under the GPL (see the file COPYING for details). This
basically means that you can do with it whatever you want. Nuff said. :-)


Credits & Contact
################################################################################

WoP has been programmed by
 * Gismo aka Uwe Fabricius,
 * Scusi aka Christoph Freundl,
 * Tom   aka Thomas Pohl.

You can contact us by eMail using dev at wormsofprey.org (or individually using
gismo/scusi/tom at wormsofprey.org) or on the IRC channel #wormsofprey on
IRCNet.


Acknowledgements
################################################################################

Intro tune by dK (www.endk.com) - original soundtrack of "Lost in the Underflow"
by Radiant (www.pouet.net/prod.php?which=12246).
Thanks for the permission to use this cool track.

Thanks to Team17 for creating the grandfather of all Worms clones and for
letting us use some of their original Worms sound samples. "Worms" is a
registered trademark of Team17 Software Limited (http://www.team17.com/).
We also used other sound samples which we found on the Internet. If you are
the owner of one of these samples and you do not want us to use it, just
send us an eMail.
