Call SDL_WM_SetIcon before SDL_SetVideoMode as suggested by the docs.
[neverball] / MANUAL
1
2                             * Neverball *
3
4
5 Tilt the  floor to roll a  ball through an obstacle  course within the
6 given time.  If the ball falls or time expires, a ball is lost.
7
8 Collect coins to unlock the exit  and earn extra balls.  Red coins are
9 worth 5.   Blue coins are  worth 10.  A  free ball is awarded  for 100
10 coins.
11
12
13 * INSTRUCTIONS
14
15 Click Play  to begin.   Mouse motion tilts  the floor.   Mouse buttons
16 rotate the  viewpoint.  The  following keyboard controls  are defined.
17 See below for details.
18
19     SPACE  Pause and resume / Release mouse grab
20     ESC    End a game / Exit
21     SHIFT  Fast camera rotation
22
23     F1     Default Camera                            (configurable)
24     F2     Lazy Camera                               (configurable)
25     F3     Static Camera                             (configurable)
26
27     F7     Toggle wire mode
28     F8     Toggle nice mode
29     F9     Toggle frame counter
30     F10    Snap a screenshot
31     F11    Toggle fullscreen
32     F12    Toggle look-around mode
33
34
35
36 * USER DATA FILES
37
38 Neverball creates a directory called ".neverball" in which  it  stores
39 user data files.   These  files  include  high  scores,  replays,  and
40 configurations.  Under Unix, Linux, and OSX this directory is  created
41 in your home directory (specifically, the directory set  in  the  HOME
42 environment variable).  Under Windows it is assumed that the user  has
43 permission to write to the game data  directory,  and  the  user  data
44 directory   is   created   within.
45
46
47
48 * HIGH SCORES
49
50 The top three fastest times through each level, and the top three coin
51 scores for each  level are stored in files  named neverballhs-* in the
52 user data directory.
53
54 The top  three fastest  times and  most coins scores  for each  set of
55 levels are also stored.  To achieve  a set score, the player must play
56 through all 25 levels of a set in one attempt.
57
58 The total set time will  include time spent during both successful and
59 unsuccesful level  plays, thus  time-outs and fall-outs  count against
60 the total time.
61
62 The  total  set  coin  count  will include  only  coins  collected  on
63 successful  level plays.   This  prevents unbounded  coin scores  from
64 being collected on levels with more than 100 coins.
65
66
67
68 * REPLAYS
69
70 Neverball  includes a  mechanism for  recording and  replaying levels.
71 The player may enter  a name for each replay at the  end of the level.
72 By default, the most recent unsaved  level will be saved to the replay
73 file named "Last.nbr".
74
75 Replay  files are  stored in  the user  data directory.   They  may be
76 copied freely.  To  view a replay you have  downloaded, simply move it
77 to  the user  data directory  and it  will appear  in the  Replay menu
78 in-game.
79
80
81
82 * CONFIGURATION
83
84 Game  settings are stored  in the  file neverballrc  in the  user data
85 directory.  This file is created  when the game exits.  It consists of
86 key /  value pairs.  Some of  these values are  configurable using the
87 in-game  options  screen.  Other  meaningful  keys  and their  default
88 values follow.
89
90     mouse_sense 300
91
92         This  key controls  mouse  sensitivity.  The  value gives  the
93         number of screen pixels the  mouse pointer must move to rotate
94         the floor  through its entire  range.  A smaller  number means
95         more sensitive.
96
97     mouse_invert 0
98
99         This key inverts the vertical mouse axis if set to 1.
100
101     key_camera_1 f1
102     key_camera_2 f2
103     key_camera_3 f3
104     key_camera_l left
105     key_camera_r right
106
107         These keys  define keyboard mappings for  camera selection and
108         rotation.  Key  names are specified using  SDL's canonical key
109         naming convention.  The three camera behaviors are as follows:
110
111         1 - Strict  camera stays behind the ball by  cueing off of the
112         velocity of the  ball.  It is very  responsive,  but sometimes
113         confusing.
114
115         2 - Lazy  camera chases a point a set  distance from the ball.
116         It is seldom  surprising, but at times it  is not sufficiently
117         responsive.
118
119         3 - Locked camera  does not rotate  except by  player command.
120
121     view_fov 50
122     view_dp  75
123     view_dc  25
124     view_dz  200
125
126         These keys  define the view of the ball.  They give  the field
127         of view in degrees,  the height of the view point,  the height
128         of the view center,  and the horizontal distance from the ball
129         in centimeters, respectively.  (The ball is  50 centimeters in
130         diameter in most levels.)
131
132         The default values  for these keys changed with version 1.2.6.
133         Some players may be interested in using the  old values.  They
134         were as follows:
135
136             view_fov 40
137             view_dp  400
138             view_dc  0
139             view_dz  600
140
141     rotate_fast 200
142     rotate_slow 100
143
144         These keys control the rate of camera rotation.  Roughly, they
145         give  the rate  of lateral  camera motion  in  centimeters per
146         seconds,  so the  actual rotation  rate depends  upon view_dz,
147         above.  The fast rate is used when the Shift key is held down.
148
149     fps 0
150
151         This key enables an on-screen frames-per-second counter. Press
152         F9 to toggle this flag in-game.
153
154     nice 1
155
156         This  key  enables  a  delay  function  after  each  frame  is
157         rendered, forcing a context  switch and ensuring that the game
158         does not utilize 100% of the CPU.  0 is off, 1 is on.
159
160         If the  frame rate is not  fast enough for you,  or you simply
161         want to  test the  performance of the  game on  your hardware,
162         disable it.
163
164         Press F8 to toggle this flag in-game.
165
166     coin png/coin.png
167     ball png/ball.png
168
169         These keys determine the texture image applied to the coin and
170         ball.  If  you prefer collecting euros  to collecting dollars,
171         set:
172
173             coin png/euro_coin.png
174
175     stereo 0
176
177         This key  enables quad-buffered stereo viewing  for those with
178         the hardware to support it.  It gives an angle in degrees that
179         determines the  interocular distance.  0  is normal non-stereo
180         viewing.  2 gives  a  good  stereo effect.   If  the eyes  are
181         swapped, give a negative value, like -2.
182
183     joystick 0
184
185         This key  enables joystick control.  0  is off, 1  is on.  The
186         game may still be controlled with the mouse even while gamepad
187         control  is enabled.   However,  random noise  from an  analog
188         controller at rest can disrupt normal mouse input.
189
190     joystick_device 0
191
192         This  number selects  which joystick  to use if  more than one
193         joystick is  found. 0 is the first  joystick, 1 is the  second
194         and so on.
195
196     joystick_axis_x 0
197
198         Joystick horizontal axis number
199
200     joystick_axis_y 1
201
202         Joystick vertical axis number
203
204     joystick_button_a 0
205
206         Joystick menu select button
207
208     joystick_button_b 1
209
210         Joystick menu cancel button
211
212     joystick_button_r 2
213
214         Joystick counter-clockwise camera rotation button
215
216     joystick_button_l 3
217
218         Joystick clockwise camera rotation button
219
220     joystick_button_exit 4
221
222         Joystick exit button
223
224
225
226 Contact: <robert.kooima@gmail.com>