source: abuse/trunk/README @ 597

Last change on this file since 597 was 596, checked in by Sam Hocevar, 8 years ago

data: merge the last fRaBs and Mac addons into the main data directory.

File size: 5.5 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  SDL-Mixer
53  One of the following sets of datafiles:
54    - Registered Abuse(original CD)
55    - Abuse Shareware
56    - fRaBs(Free Abuse)
57  OpenGL is optional.
58
59
604. RUNNING ABUSE-SDL
61
62If Abuse-SDL has been installed properly, the command:
63
64  abuse
65
66will start the game.
67
68The following command-line switches can be used:
69
70  -datadir <arg>    Set the location of the datafiles
71  -doublebuf        Enable double buffering
72  -edit             Start in editor mode
73  -f <arg>          Load the map file named <arg>
74  -fullscreen       Enable fullscreen mode
75  -gl               Enable OpenGL (if supported)
76  -antialias        Enable anti-aliasing (only with -gl)
77  -lisp             Start in lisp interpreter mode
78  -mono             Disable stereo sound
79  -nodelay          Run at maximum speed
80  -nosound          Disable sound
81  -scale <arg>      Scale by <arg> amount
82
83
845. CONFIGURATION
85
86Abuse-SDL also has a configuration file where these options can be set
87instead of using the command line.  The file "abuserc" will be created in
88your ~/.abuse directory the first time Abuse-SDL is run.
89Lines starting with a ';' are comments.
90Setting an option to '1' turns it on, and '0' turns it off.
91
92To change the keys used in the game, simply type the key after the option.
93The following special keys can also be used:
94  LEFT, RIGHT, UP, DOWN : Cursor keys and keypad.
95  CTRL_L, CTRL_R        : Left and right CTRL keys.
96  ALT_L, ALT_R          : Left and right ALT keys.
97  SHIFT_L, SHIFT_R      : Left and right SHIFT keys.
98  F1 - F10              : Function keys 1 through 10.
99  TAB                   : TAB key.
100  BACKSPACE             : Backspace key.
101  ENTER                 : Enter key
102  INSERT, DEL           : Insert and Delete keys.
103  PAGEUP, PAGEDOWN      : PageUp and PageDown keys.
104  CAPS, NUM_LOCK        : Caps-Lock and Num-Lock keys.
105  SPACE                 : Spacebar.
106
107The default key settings are as follows:
108  Left        : Left cursor key.
109  Right       : Right cursor key.
110  Up/Jump     : Up cursor key.
111  Down/Use    : Down cursor key.
112  Prev Weapon : Left or Right CTRL keys.
113  Next Weapon : Insert key.
114
115The mouse always controls your aim, with Left button for fire and
116Right button for special.  Mousewheel can be used for changing weapons.
117
118
1196. INSTALLING THE DATAFILES
120
121Abuse-SDL requires a set of datafiles(graphics, sounds, maps and so on) to be
122installed before it will run.  They are available as a separate package from
123the Abuse-SDL website.
124
125By default, Abuse-SDL expects the datafiles to be installed in the following
126location:
127
128  /usr/local/share/games/abuse
129
130However it is possible to change this and tell Abuse-SDL where to find the
131files if they are in another location.
132The location can be set when Abuse-SDL is compiled.  See the INSTALL file for
133instructions on how to do this.
134You can also specify the location with the -datadir argument when Abuse-SDL is
135run.  See section 4 above.
136Finally, the location can be set in the configuration file. See section 5 above.
137
138To install the datafiles, simply unpack the archive into a location of your
139choice (preferably '/usr/local/share/games/abuse' as mentioned above).
140
141
1427. NOTES
143
144Scaling:
145  Scaling is still experimental and not very fast.  Try scaling by different
146  amounts to see which ones work the best.
147
148OpenGL:
149  OpenGL can be used to provide hardware accelerated scaling and anti-aliasing.
150  You will require a 3D card with the appropriate drivers and GL libraries
151  installed for this to work.
152
153fRaBs:
154  The current release of fRaBs has some naming issues under Linux.
155  In the 'addon/leon/' directory a lot of the files are uppercase when Abuse
156  is expecting them to be lowercase.
157  Renaming the files to be all lowercase will fix this problem.
158
159
1608. SPECIAL THANKS
161
162Go to Jonathan Clark, Dave Taylor and the rest of the Crack Dot Com team for
163making the best 2D platform shooter ever, and then releasing the code that
164makes Abuse-SDL possible.
165
166Also, thanks go to Jonathan Clark for allowing Anthony to distribute the
167original datafiles with Abuse-SDL.
168
169Thanks also to everyone who has contributed ideas, bug reports and patches.
170See the AUTHORS file for details.
171
172
1739. FEEDBACK
174
175If you have any questions, comments or criticism, Sam's email address is:
176
177    sam@hocevar.net
178
179The Abuse-SDL webpage can be found at:
180
181  http://abuse.zoy.org/
182
183----
184
185Have fun!
Note: See TracBrowser for help on using the repository browser.