finalise readme for release
[wormy.git] / wormy.txt
1 ___����________________________________________________________����___________
2   ����                                                         �����
3  ���                                                            ����     ����
4 ���      �����          ��������       �����    ����  ����      ���     �����
5 ���     �������       �����������     �������  �������������     ��    ��� ���
6 ��     ���   ���     �����    ����   ����  ������  ����  ���     ���  ���� ���
7 ��     ��     ��     ��  �      ��� ����     ���  ������  ���    ���  ���   ��
8 ��     ��     ��     �� ��      ��� ���      ��� ���� ��� ���    ��� ����   ��
9 ��     ���   ���     �� ��       �� ���      �������   ��� ��     �������   ��
10 ��     ���   ���    ��� ��       �� ��       �� ���    ��� ���     �����   ���
11 ���     ��� ���     ��� ��       �� ���      �� ����  ���� ���             ���
12 ���      �����     ���  ���     ��� ���      ��  ��������  ���            ���
13  ���      ���      ���  ���     ��� ���      ���  ������   ���            ���
14   ����  �������  ����    ���   ���  ����     ���            �����       ����
15    �������� ��������     ���������   ���     ���             ���������������
16     �����     �����       �������     ��      ���              �����������
17 ______________________________________________________________________________
18
19  Version:                 1.00.36 (released march 6, 2002)
20   Author:                  SHIAR (wormy@shiar.org - www.shiar.org)
21    File(s):                 wormy.86g (main program 6447B, levels 2404B)
22                              wormy.txt (readme); levels/*; src/* (sources)
23                               bin/wormedit.exe (level editor); bin/* (misc)
24       Description:             perfect Nibbles game with free movement, 9 game
25                                 modes, for 1-4 players, many levels and editor
26        Where to get this game:   shiar.org, the official home of Wormy
27         Additional Credits to:    Matthew Shepcar and Jonah Cohen
28 ______________________________________________________________________________
29 ____ _  _ ___    ______ ______  ______ _____ __   _ __   _ _____ __   _ ______
30   |  |__| |__    |_____]|_____ |  ____   |   | \  | | \  |   |   | \  ||  ____ 
31   |  |  | |__    |_____]|______|_____| __|__ |  \_| |  \_| __|__ |  \_||_____/ 
32
33  To get started, simply upload the file wormy.86g to your calculator/emu.
34     This file contains Wormy and the first levelfile. Then you simply run
35        Wormy by typing asm(wormy   or by using some shell (just no AShell.)
36          When multiple levelfiles are present, you have to choose one first.
37            Next, you'll get in the main menu. Use up and down to choose an
38              option, left and right to alter it, and 2nd or enter to select.
39
40        - Mode - change gamemode (further details below). Select it to start.
41         - Level - select the (starting) level. Selecting it allows you to
42                    customize some stuff for multiplayer levels.
43           - Link  - toggle linkplay. Remember to activate it on _both_ calcs.
44            - Worms  - set the number of players (upto 4) and teams (1 or 2).
45             - worm    - select it to alter the selected player's name.
46              - controls - select and press your buttons for left and right.
47 ______________________________________________________________________________
48 _______   _____  __   _ . _______      ______  _____ _______
49  |     \ |     | | \  | '    |         |     \   |   |______
50  |_____/ |_____| |  \_|      |         |_____/ __|__ |_______
51
52  That's really all you have to do. Avoid your worm from crashing into anything
53    (walls, bouncies, and worms; including yourself) by turning it left/right.
54      Default controls are:  [1] left/right  [2] F1/F2  [3] sto/,  [4] enter/+
55        but they can be altered to anything except these two keys:
56          [EXIT] - this will always exit to the game-over screen.
57            [MORE] - will pause and allow you to change contrast 'n stuff.
58 ______________________________________________________________________________
59 __  _  _ _______                    ______   _____  __   _ _______
60  |  |  | |______ |      |           |     \ |     | | \  | |______
61  |__|__| |______ |_____ |_____      |_____/ |_____| |  \_| |_______
62
63  At the end of each game, the stats-screen will be displayed. It shows the
64        score and deaths for each worm, and hiscore for singleplayer games.
65                The winner(s) of multiplayer games will be denoted with an *.
66                       Hit enter to return to the main menu.
67 ______________________________________________________________________________
68 ________ _______ _______ _________    _______  _____  ______  _______ ______
69  |  ____ |_____| |  |  | |_______     |  |  | /     | |     \ |______ |______
70  |_____| |     | |  |  | |______      |  |  | \_____| |_____/ |______ ______/
71
72                                SINGLEPLAYER
73                                  Get all the food
74                                     to proceed to the next
75                          PEAWORM        level. You can start in
76                           Like Scabby's       any level you have been before.
77                     TRON    original Peaworm;
78             DEATH-    Your      just get as many
79  FOODMATCH   MATCH      tail           peas as you can
80  Deathmatch   Multiplay-  doesnt            in a single level.
81   with food.   er game in    go away.
82   The one who   which u try     Try to sur-
83   reaches the     to kill the         vive as long
84    score-limit      other worm(s)              as possible.
85    first, wins.        before they kill
86                           you. There's no food,
87     TIMEMATCH                 but by default worms slowly
88      Try to stay                     get larger over time.
89      alive longer      RACE
90       than the other      All worms
91        players. If the        have to move
92        growth is set to 1          aound like race-cars.
93         you will get a nice                For each completed lap
94          multiplayer Tron-game.                         you'll get 20 points.
95                                   CTF
96          BTW                        Get the
97           Unless                      enemy flag
98            specified                    and return it
99             otherwise,                    to your own flag.
100             you'll loose                    You won't loose points
101              10 points for                    for dieing, and players 1+3
102              dieing, but earn                   and 2+4 are teamed together.
103               10 for eating a pea.
104 ______________________________________________________________________________
105 __      _______ _    _ ________       _______
106  |      |______  \  /  |______ |      |______
107  |_____ |______   \/   |______ |_____ ______/
108
109             Wormy comes together with WORMEDIT, the Wormy level editor for DOS
110       I wrote. Start wormedit.exe and make some kick-ass levels! (Please do!!)
111 Also send me your levels so I can put them on my page. More info at shiar.org.
112 Note the editor is still beta and incomplete, and may crash your pc or calc.
113 Use with caution and clue, and don't complain! You have been warned ;)
114 ______________________________________________________________________________
115 _______  ________     _______  _____  _     _  ______ _______ ______
116  |     | |______      |       |     | |     | |_____/ |______ |______
117  |_____| |            |_____  |_____| |_____| |    \_ ______| |_______
118
119  Argh, a disclaimer :( Just note Wormy was a non-profit project
120                  which took a lot of my (spare) time, so please don't go demand
121   stuff (just _ask_ me) or sue me (f)or anything. By default
122                  I am not responsible for any damage Wormy causes. Furthermore,
123    you may not: release an altered version of Wormy (the source
124                     has been included for learning practises ONLY), distribute
125     it w/o this readme file included (plz leave the zipfile
126                              intact). Any questions and stuff, just _ask_ me!
127 ______________________________________________________________________________
128 __     _ _____ _______ _______  _____   ______ __   _
129  |_____|   |   |______    |    |     | |_____/   \__|
130  |     | __|__ ______|    |    |_____| |    \______/
131
132         This is a short historical overview of Worm(y):
133                                          (facts may not match reality)
134       - End 1998 - Matthew Shepcar releases Peaworm, worm in its simplest form
135      - Scabby didnt release another version with levels and vertical scrolling
136     - End 1999 - I (Shiar) got his permission to entirely screw up his Worm >:)
137    - Jonah Cohen helped me for a while, but soon he either died or got bored
138   - June 2000 - Worm just didn't want to work correctly (linkplay problems
139                  mostly), so I decided to take a break to continue later..
140  - Feb 2001 - After a huge break I figured it's time to complete Worm(y)
141 - March 2002 - Completed at last, and everyone lived happily ever after
142
143  So, it's _finally_ done. It should be pretty playable and bugless
144   (no guarantees :P) Hope it was worth the wait. I may release
145     some new versions later, prolly with more levels,
146        improvements to the editor, fixes,
147            or 'maybe'-stuff...
148 ______________________________________________________________________________
149 ________  ______ _______ ______  _____ _______ ______
150  |       |_____/ |______ |     \   |      |    |______
151  |_____  |    \_ |______ |_____/ __|__    |    ______|
152
153  EMAiL wormy@shiar.org       Please send me comments, fanmail and your levels!
154   WWWW http://shiar.org       Be sure to visit :) Lotsa stuff for your ticalc
155    iRC shiar @ efnet|opn       Idling here (or more personal @ irc.shiar.net)
156
157     Matthew Shepcar - for writing the original Peaworm and Wonderworm
158      Jonah Cohen     - wrote some parts of Worm (like scrolling)
159       Aaron Curtis    - betatesting, great levels, yas shell :)
160        Willyslice      - some excellent betatesting and levels
161         Eric Samuel     - betatesting and stuff
162          John Nesler     - another betatester
163           Free Bird       - for having an 86
164
165            ...and everybody else who cared :)
166 ______________________________________________________________________________
167  
168 --------------------------\ http://wormy.shiar.org \--------------------------
169 ______________________________________________________________________________