source: abuse/trunk/README @ 581

Last change on this file since 581 was 68, checked in by Sam Hocevar, 12 years ago
  • Version 0.7.1 is ready.
File size: 6.1 KB
Line 
1Abuse-SDL 0.7.1 README
2----------------------
3
4----
5
61. Introduction
72. Additional Features
83. Requirements
94. Running Abuse-SDL
105. Configuration
116. Installing the datafiles.
127. Notes
138. Special Thanks
149. Feedback
15
16----
17
18
191. INTRODUCTION
20
21Welcome to Abuse-SDL, the port of the classic game Abuse to the
22Simple DirectMedia Layer.  Abuse was originally developed by
23Crack dot Com and released in 1995 for MS-DOS.  A Linux version was
24also made available at a later date.  It had a few limitations
25the most restrictive of which was that it only ran on an 8-bit
26display, and only in a window.
27Abuse-SDL will run at any colour depth and supports fullscreen
28mode, as well as many other new features.  It should also be more
29portable and hopefully run on a variety of *nix variants, and possibly
30other systems supported by the SDL library.
31
32
332. ADDITIONAL FEATURES
34
35Abuse-SDL has the following extra features over the original
36Abuse:
37
38  Runs at a screen bit depth of 8, 16, 24 or 32.
39  Fullscreen display.
40  Scaling by any amount (eg. 2, 3 or 4)
41  OpenGL support for hardware scaling and anti-aliasing.
42  Stereo sound with panning.
43  Mousewheel support for changing weapons.
44  Customizable keys.
45
46
473. REQUIREMENTS
48
49Abuse-SDL has the following requirements:
50
51  SDL 1.1.6 or above.
52  One of the following sets of datafiles:
53    - Registered Abuse(original CD)
54    - Abuse Shareware
55    - fRaBs(Free Abuse)
56  OpenGL is optional.
57
58
594. RUNNING ABUSE-SDL
60
61If Abuse-SDL has been installed properly, the command:
62
63  abuse
64
65will start the game.
66
67The following command-line switches can be used:
68
69  -datadir <arg>    Set the location of the datafiles
70  -doublebuf        Enable double buffering
71  -edit             Start in editor mode
72  -f <arg>          Load the map file named <arg>
73  -fullscreen       Enable fullscreen mode
74  -gl               Enable OpenGL (if supported)
75  -antialias        Enable anti-aliasing (only with -gl)
76  -lisp             Start in lisp interpreter mode
77  -mono             Disable stereo sound
78  -nodelay          Run at maximum speed
79  -nosound          Disable sound
80  -scale <arg>      Scale by <arg> amount
81
82
835. CONFIGURATION
84
85Abuse-SDL also has a configuration file where these options can be set
86instead of using the command line.  The file "abuserc" will be created in
87your ~/.abuse directory the first time Abuse-SDL is run.
88Lines starting with a ';' are comments.
89Setting an option to '1' turns it on, and '0' turns it off.
90
91To change the keys used in the game, simply type the key after the option.
92The following special keys can also be used:
93  LEFT, RIGHT, UP, DOWN : Cursor keys and keypad.
94  CTRL_L, CTRL_R        : Left and right CTRL keys.
95  ALT_L, ALT_R          : Left and right ALT keys.
96  SHIFT_L, SHIFT_R      : Left and right SHIFT keys.
97  F1 - F10              : Function keys 1 through 10.
98  TAB                   : TAB key.
99  BACKSPACE             : Backspace key.
100  ENTER                 : Enter key
101  INSERT, DEL           : Insert and Delete keys.
102  PAGEUP, PAGEDOWN      : PageUp and PageDown keys.
103  CAPS, NUM_LOCK        : Caps-Lock and Num-Lock keys.
104  SPACE                 : Spacebar.
105
106The default key settings are as follows:
107  Left        : Left cursor key.
108  Right       : Right cursor key.
109  Up/Jump     : Up cursor key.
110  Down/Use    : Down cursor key.
111  Prev Weapon : Left or Right CTRL keys.
112  Next Weapon : Insert key.
113
114The mouse always controls your aim, with Left button for fire and
115Right button for special.  Mousewheel can be used for changing weapons.
116
117
1186. INSTALLING THE DATAFILES
119
120Abuse-SDL requires a set of datafiles(graphics, sounds, maps and so on) to be
121installed before it will run.  They are available as a separate package from
122the Abuse-SDL website.
123
124By default, Abuse-SDL expects the datafiles to be installed in the following
125location:
126
127  /usr/local/share/games/abuse
128
129However it is possible to change this and tell Abuse-SDL where to find the
130files if they are in another location.
131The location can be set when Abuse-SDL is compiled.  See the INSTALL file for
132instructions on how to do this.
133You can also specify the location with the -datadir argument when Abuse-SDL is
134run.  See section 4 above.
135Finally, the location can be set in the configuration file. See section 5 above.
136
137To install the datafiles, simply unpack the archive into a location of your
138choice (preferably '/usr/local/share/games/abuse' as mentioned above).
139
140
1417. NOTES
142
143Scaling:
144  Scaling is still experimental and not very fast.  Try scaling by different
145  amounts to see which ones work the best.
146
147OpenGL:
148  OpenGL can be used to provide hardware accelerated scaling and anti-aliasing.
149  You will require a 3D card with the appropriate drivers and GL libraries
150  installed for this to work.
151
152fRaBs:
153  The current release of fRaBs has some naming issues under Linux.
154  In the 'addon/leon/' directory a lot of the files are uppercase when Abuse
155  is expecting them to be lowercase.
156  Renaming the files to be all lowercase will fix this problem.
157
158BOSS_ANT has no value:
159  On some systems when running Abuse-SDL, the following error is given:
160    "BOSS_ANT has no value"
161  The exact cause of this is unknown, however there is a workaround.
162  If you don't already have a '.abuse' directory in your $HOME directory,
163  simply create it with the following command:
164
165    mkdir ~/.abuse
166
167  Then copy the file 'gamma.lsp' that is included with Abuse-SDL into that
168  directory.  This should fix the problem and allow Abuse-SDL to run correctly.
169  The 'gamma.lsp' file stores the settings for gamma correction and be adjusted
170  from the main game menu if desired.
171
172
1738. SPECIAL THANKS
174
175Go to Jonathan Clark, Dave Taylor and the rest of the Crack Dot Com team for
176making the best 2D platform shooter ever, and then releasing the code that
177makes Abuse-SDL possible.
178
179Also, thanks go to Jonathan Clark for allowing Anthony to distribute the
180original datafiles with Abuse-SDL.
181
182Thanks also to everyone who has contributed ideas, bug reports and patches.
183See the AUTHORS file for details.
184
185
1869. FEEDBACK
187
188If you have any questions, comments or constructive criticism,
189Anthony's email address is:
190
191  trandor@labyrinth.net.au
192
193The Abuse-SDL webpage can be found at:
194
195  http://abuse.zoy.org/
196
197----
198
199Have fun!
Note: See TracBrowser for help on using the repository browser.