source: abuse/trunk/README

Last change on this file was 621, checked in by Sam Hocevar, 7 years ago

doc: update changelog and various documentation files.

File size: 5.4 KB
Line 
1Abuse 0.8 README
2----------------
3
4----
5
61. Introduction
72. Additional Features
83. Requirements
94. Running Abuse
105. Configuration
116. Installing the datafiles
127. Notes
138. Special Thanks
149. Feedback
15
16----
17
18
191. INTRODUCTION
20
21Welcome to Abuse, the port of the classic game Abuse to the Simple
22DirectMedia Layer. Abuse was originally developed by Crack dot Com and
23released in 1995 for MS-DOS. A Linux version was also made available at
24a later date. It had a few limitations the most restrictive of which was
25that it only ran on an 8-bit display, and only in a window.
26
27Abuse will run at any colour depth and supports fullscreen mode, as
28well as many other new features. It should also be more portable and
29hopefully run on a variety of *nix variants, and possibly other systems
30supported by the SDL library.
31
32
332. ADDITIONAL FEATURES
34
35Abuse has the following extra features over the original:
36
37  Runs at a screen bit depth of 8, 16, 24 or 32.
38  Fullscreen display.
39  Scaling by any amount (eg. 2, 3 or 4)
40  OpenGL support for hardware scaling and anti-aliasing.
41  Stereo sound with panning.
42  Mousewheel support for changing weapons.
43  Customizable keys.
44
45
463. REQUIREMENTS
47
48Abuse has the following requirements:
49
50  SDL 1.1.6 or above.
51  SDL-Mixer
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
60
61If Abuse 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 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 is run.
88
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 requires a set of datafiles (graphics, sounds, maps and so on)
122to be installed before it will run. They are available as a separate
123package from the Abuse website.
124
125By default, Abuse 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 where to find the
131files if they are in another location.
132
133The location can be set when Abuse is compiled. See the INSTALL file for
134instructions on how to do this.
135
136You can also specify the location with the -datadir argument when
137Abuse is run. See section 4 above.
138
139Finally, the location can be set in the configuration file. See section
1405 above.
141
142To install the datafiles, simply unpack the archive into a location of your
143choice (preferably '/usr/local/share/games/abuse' as mentioned above).
144
145
1467. NOTES
147
148Scaling:
149  Scaling is still experimental and not very fast.  Try scaling by different
150  amounts to see which ones work the best.
151
152OpenGL:
153  OpenGL can be used to provide hardware accelerated scaling and anti-aliasing.
154  You will require a 3D card with the appropriate drivers and GL libraries
155  installed for this to work.
156
157fRaBs:
158  The current release of fRaBs has some naming issues under Linux.
159  In the 'addon/leon/' directory a lot of the files are uppercase when Abuse
160  is expecting them to be lowercase.
161  Renaming the files to be all lowercase will fix this problem.
162
163
1648. SPECIAL THANKS
165
166Go to Jonathan Clark, Dave Taylor and the rest of the Crack Dot Com team
167for making the best 2D platform shooter ever, and then releasing the
168code that makes Abuse possible.
169
170Also, thanks go to Jonathan Clark for allowing Anthony to distribute the
171original datafiles with Abuse.
172
173Thanks also to everyone who has contributed ideas, bug reports and patches.
174See the AUTHORS file for details.
175
176
1779. FEEDBACK
178
179If you have any questions, comments or criticism, Sam's email address is:
180
181    sam@hocevar.net
182
183The Abuse webpage can be found at:
184
185  http://abuse.zoy.org/
186
187----
188
189Have fun!
Note: See TracBrowser for help on using the repository browser.