~ivantis/armagetronad/sty+ct+ivantis

« back to all changes in this revision

Viewing changes to src/doc/config.html

  • Committer: ivantis
  • Date: 2008-09-09 21:33:18 UTC
  • Revision ID: ivantis@ivantis.net-20080909213318-k43y6yuq0zd6wbsa
first commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
 
 
3
 
 
4
 
 
5
 
 
6
 
 
7
 
 
8
 
 
9
 
 
10
 
 
11
 
 
12
 
 
13
 
 
14
 
 
15
 
 
16
 
 
17
 
 
18
 
 
19
 
 
20
 
 
21
 
 
22
 
 
23
 
 
24
 
 
25
 
 
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
 
 
63
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
 
64
<html>
 
65
<head>
 
66
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 
67
   <meta name="date" content="2008-09-03T17:19:25+01:00">
 
68
 
 
69
   <meta name="author" content="Manuel Moos">
 
70
   <title>Armagetron Advanced: Documentation</title>
 
71
   <meta name="description" content="Armagetron Advanced: Documentation">
 
72
</head><body>
 
73
 
 
74
 
 
75
 
 
76
 
 
77
 
 
78
<table width="90%" align=center>
 
79
<tr>
 
80
 
 
81
 
 
82
 
 
83
 
 
84
 
 
85
 
 
86
 
 
87
 
 
88
 
 
89
 
 
90
 
 
91
 
 
92
 
 
93
 
 
94
 
 
95
 
 
96
<td align=center width="15%">
 
97
<a href="index.html" target="_top">First Start</a>
 
98
</td>
 
99
 
 
100
 
 
101
 
 
102
 <td align=center width="15%">
 
103
<a href="install_linux.html" target="_top"> Installation</a>
 
104
</td>
 
105
      
 
106
<td align=center width="15%">
 
107
<a href="network.html" target="_top">Network Play</a>
 
108
</td>
 
109
 
 
110
<td align=center width="15%">
 
111
<strong>Configuration</strong> 
 
112
</td>
 
113
 
 
114
<td align=center width="10%">
 
115
<a href="faq.html" target="_top">FAQ</a>
 
116
</td>
 
117
 
 
118
<td align=center width="15%">
 
119
<a href="compile.html" target="_top">Redistribution</a>
 
120
</td>
 
121
 
 
122
 
 
123
</tr>
 
124
</table>
 
125
 
 
126
 
 
127
 
 
128
<a name=><h1 align=center>Configuration</h1></a>
 
129
 
 
130
All the normal user settings of Armagetron Advanced are configurable in
 
131
the menu system. Since it is quite easy to get lost, here is a
 
132
(not always up-to-date) map of all submenus (the menu items have
 
133
an auto help display below if you don't touch any keys for some seconds,
 
134
 so to let you keep the overview here, I omit the simple items):
 
135
 
 
136
 
 
137
 
 
138
 
 
139
 
 
140
<a name=><h4 align=left>Main Menu</h4></a>
 
141
<ul>
 
142
<li><strong>Game</strong> (start and setup a game)</li>
 
143
<ul>
 
144
<li><strong>Local Game</strong> (Starts a local game)</li>
 
145
<li><strong>Network Game</strong> (Connects to or creates a network game)</li>
 
146
<li><strong>Game Setup</strong> (Sets your favourite single player game mode: number of AI opponents)</li>
 
147
</ul>
 
148
<li><strong>Player Setup</strong> (Player customisation: keyboard input, camera setup, multiplayer
 
149
mode on one computer)</li>
 
150
<ul>
 
151
<li><strong>Player 1-4</strong> (the settings for this player)</li>
 
152
<ul>
 
153
<li><strong>Input Configuration</strong> (keyboard and mouse setup)</li>
 
154
<li><strong>Camera Input Configuration</strong> (keyboard and mouse setup for camera controls)</li>
 
155
<li><strong>Camera Setup</strong> (camera mode options)</li>
 
156
<li><strong>Instant Chat</strong> (things you can say with one keystroke)</li>
 
157
</ul>
 
158
<li><strong>Assign Viewports To Players</strong> (which player sees himself on which part of
 
159
the screen)</li>
 
160
</ul>
 
161
<li><strong>System Setup</strong> (Configure sound)</li>
 
162
<ul>
 
163
<li><strong>Display Settings</strong> (screen resolution and graphic details/preferences)</li>
 
164
<ul>
 
165
<li><strong>Screen Mode</strong> (resolution and windowed/fullscreen selection)</li>
 
166
<li><strong>Preferences</strong> (things that depend more on your personal taste)</li>
 
167
<li><strong>Detail Settings</strong> (things that affect visual quality and depend on your
 
168
system's OpenGL power)</li>
 
169
<li><strong>Performance Tweaks</strong> (settings that increase graphics speed, but
 
170
may not work on your system)</li>
 
171
</ul>
 
172
<li><strong>Sound Settings</strong> (sound quality)</li>
 
173
<li><strong>Misc Stuff</strong> (things that did not fit anywhere else: Moviepack, console text
 
174
output, menu wrap option and global keyboard configuration)</li>
 
175
<ul>
 
176
<li><strong>Global Keyboard Configuration</strong> (keyboard setup for player-independent functions (console, scores))</li>
 
177
<li><strong>Language settings</strong> (Choose the language of Armagetron Advanced here)</li>
 
178
</ul>
 
179
</ul>
 
180
</ul>
 
181
 
 
182
 
 
183
 
 
184
<a name=new><a name=><h3 align=left>Game Rule Settings</h3></a></a>
 
185
<p align=justify>
 
186
Some of the maybe less obvious game settings in "Game Setup" available since version 0.2 are explained here:
 
187
<ul>
 
188
<li>The AIs come in various intelligence grades. Select it in the "AI IQ" menu item.</li>
 
189
<li>Explosions can blow away walls. Select in "Blast Radius" how much destruction they bring.</li>
 
190
<li>Cycle walls can be of finite length (a la snake). Choose in "Wall Length" how long they should be.</li>
 
191
<li>The delay between the a cycle explosion and the disappearing of its wall can be configured in "Wall Delay".</li>
 
192
<li>Arena size and overall game speed can be adjusted in "Arena Size" and "Speed". Note that the setting here is logarithmic; that
 
193
means that by increasing the value by 2, you double the arena size/game speed. by increasing the value by 6, you multiply the size/speed by a factor of 8.</li>
 
194
</ul>
 
195
Only important for multiplayer games:
 
196
<ul>
 
197
<li>Limits on the number of teams and the number of players per team can be set in the "Min/Max teams/players per team" settings.</li>
 
198
<li>You can control team ballance with the "Max imbalance" and "Ballance with AIs" settings.</li>
 
199
</ul>
 
200
</p>
 
201
 
 
202
<a name=recording><h2 align=left>Debug Recording</h2></a>
 
203
<p align=justify>
 
204
Armagetron Advanced supports recording whole program sessions for debugging and performance tuning.
 
205
</p>
 
206
<a name=><h3 align=left>Usage</h3></a>
 
207
<p align=justify>
 
208
To record a program session, use the command line parameter <code>--record &lt;filename&gt;</code>;
 
209
this will store the recording in the file <code>&lt;filename&gt;</code> in the current directory.
 
210
A suggested file extension would be <code>.rec</code>.
 
211
</p>
 
212
<p align=justify>
 
213
To playback a recording, use the command line parameter <code>--playback &lt;filename&gt;</code>.
 
214
If you want to skip ahead to the interesting part,
 
215
you can do so by giving the additional parameter <code>--fastforward &lt;time&gt;</code>.
 
216
While playing back a client session, the current time will always be 
 
217
displayed in the upper right corner of the screen.
 
218
</p>
 
219
<p align=justify>
 
220
During playback, input from the keyboard is not disabled.
 
221
You can use it safely for nonessential input,
 
222
like controlling the camera or toggling the score display.
 
223
However, issuing cycle turn commands is likely to break the playback.
 
224
It is possible to combine both playback and recording arguments on the command line;
 
225
this gives you rudimentary recording editing possibilities.
 
226
</p>
 
227
<p align=justify>
 
228
The command line switch <code>--benchmark</code> plays the recording 
 
229
back frame by frame as it was recorded and give performance statistics at the end of the run. 
 
230
Without this option, the playback will try to match the real speed.
 
231
</p>
 
232
 
 
233
<p align=justify>
 
234
On MS Windows, to give the Armagetron Advanced command line arguments, open up a command console (aka dos box)
 
235
and type (if you have installed Armagetron Advanced into E:\Program Files\armagetronad-dedicated):
 
236
<pre>
 
237
E:\
 
238
cd E:\Program Files\armagetronad-dedicated
 
239
./armagetronad-dedicated &lt;command line arguments&gt;
 
240
</pre>
 
241
But you don't have to go through that hassle; there are three start menu entries that record
 
242
to a file on your desktop and play it back normally or in benchmarking mode.
 
243
</p>
 
244
 
 
245
<a name=><h3 align=left>Background</h3></a>
 
246
<p align=justify>
 
247
Recording works by storing all external input
 
248
(keypresses, time measurements, file reads and network traffic)
 
249
in a file and feeding the stored input to the program on playback.
 
250
Due to the purpose and the implementation, there are limitations: 
 
251
It is unlikely that a recording done with one version will play back on another version.
 
252
It often happens that even with the same version, different builds
 
253
(Windows vs. Linux, different GCC versions used to compile, PC vs. Mac, Debug vs. Optimized)
 
254
produce incompatible playbacks because of subtle
 
255
differences in the way numbers are treated by different processors,
 
256
compilers and operating systems.
 
257
</p>
 
258
<a name=><h3 align=left>Protect Your Passwords</h3></a>
 
259
<p align=justify>
 
260
Since all network traffic is logged and the ingame admin password is currently sent unencrypred,
 
261
it is not a good idea to publish server recordings where you or anyone else logs in as admin.
 
262
The same holds for a client session recording where you log in anywhere; remember that all your
 
263
keypresses are recorded without exception.
 
264
</p>
 
265
<a name=><h3 align=left>Primary Use: Bug Reports</h3></a>
 
266
<p align=justify>
 
267
Sometimes, when you report a bug, the team may ask you do send a recording of
 
268
the bug happening.
 
269
It is then most useful if you do your recording while you have
 
270
VSYNC enabled in your video driver settings
 
271
(so your framerate and the rate of recording is limited by your video refresh,
 
272
which makes the recording smaller and faster to fast forward through) and spark rendering disabled.
 
273
Please try to make the bug happen as soon as possible. 
 
274
Because of the limitations of the recordings, we'll also
 
275
need to know the exact version and build you are using.
 
276
A screenshot or even a series of screenshots edited by you that show us what you think is
 
277
wrong also helps greatly;
 
278
if you make them while playing back your recording,
 
279
we have the added benefit that we see the timestamp and know where to fast forward to.
 
280
</p>
 
281
<a name=><h3 align=left>Secondary Use: Demo Recording</h3></a>
 
282
<p align=justify>
 
283
If you want to use a recording to show off,
 
284
it is best to do record it on the client in a network
 
285
session even if you just want to demonstrate your superior AI killing ability.
 
286
This increases the chances for compatibility greatly because all game physics decisions are
 
287
made on the server and stored in the recording in the form of the network traffic.
 
288
Keep the limitations in mind, though;
 
289
it is not a bug if this recording does not play back
 
290
on anything but your own machine and the exact version it was recorded with.
 
291
</p>
 
292
 
 
293
 
 
294
<a name=files><h2 align=left>Advanced Configuration</h2></a>
 
295
 
 
296
<p align=justify>
 
297
Take a look at the files
 
298
<strong>settings.cfg</strong> and <strong>settings_dedicated.cfg</strong> for the dedicated server
 
299
(best save all your changes to 
 
300
<strong>autoexec.cfg</strong> if you don't want the next
 
301
release of Armagetron Advanced to overwrite them). They contain a lot of settings
 
302
inaccessible from the menu system. All relevant settings are synced from the
 
303
server to the connected clients.
 
304
You can place comments preceeded by <code>#</CODE> anywhere in these files.
 
305
</p>
 
306
 
 
307
<p align=justify>
 
308
The settings that affect only the visual appearance (<code>FLOOR_*</code> ...)
 
309
are not transferred; It stays a matter of taste if you want the floor
 
310
red or yellow.
 
311
</p>
 
312
 
 
313
<a name=><h3 align=left>Game Physics</h3></a>
 
314
<a name=><h4 align=left>Speed</h4></a>
 
315
<p align=justify>
 
316
The game is too slow for you? Then 
 
317
play a bit with <code>CYCLE_SPEED</code> and all the other
 
318
nice variables and see what happens.
 
319
Not all possible setting items are included in these files, you can add everything
 
320
you find in <a href="commands.html" target=_top>this unsorted document</a>.
 
321
</p>
 
322
 
 
323
<p align=justify>
 
324
The base acceleration in an open field is <pre>(CYCLE_SPEED-current speed) * f</pre>
 
325
where f is
 
326
<code>CYCLE_SPEED_DECAY_BELOW</code> if the current speed is smaller than <code>CYCLE_SPEED</code> resp.
 
327
<code>CYCLE_SPEED_DECAY_ABOVE</code> if it is bigger. The effect is that the cycle's speed will
 
328
approach <code>CYCLE_SPEED</code> over time. The bigger the constants, the faster the approach.
 
329
</p>
 
330
 
 
331
<p align=justify>
 
332
The acceleration caused by the wall at distance <code>D</code> is
 
333
<pre>acceleration=CYCLE_ACCEL * F(D)</pre>
 
334
with
 
335
<pre>
 
336
F(D) = 1 / (CYCLE_ACCEL_OFFSET + D) 
 
337
     - 1 / (CYCLE_ACCEL_OFFSET + CYCLE_WALL_NEAR)
 
338
</pre>
 
339
if the wall is closer than <code>CYCLE_WALL_NEAR</code>. 
 
340
the stuff in the second
 
341
line just makes sure that the acceleration is 0 if 
 
342
<code>D=CYCLE_WALL_NEAR</code>, so there are no "jumps".
 
343
Depending on the nature of the wall (whether it belongs to you, your teammate, 
 
344
your enemy or is the arena rim), the acceleration gets multiplied with 
 
345
<code>CYCLE_ACCEL_SELF</code>, <code>_TEAM</code> resp. <code>_ENEMY</code> or <code>_RIM</code>. If your cycle
 
346
is stuck between one of your walls and a wall of any other type, your total
 
347
acceleration by walls gets multiplied by <code>CYCLE_ACCEL_SLINGSHOT</code>. If you drive
 
348
between two walls that are not your own, your acceleration gets multiplied with
 
349
<code>CYCLE_ACCEL_TUNNEL</code>.
 
350
</p>
 
351
 
 
352
<p align=justify>
 
353
Furthermore, to make the overall speed feeling configurable without disturbing the
 
354
tuning of the values with respect to each other, <code>CYCLE_SPEED</code> and <code>CYCLE_ACCEL</code>
 
355
are multiplied by exp(<code>SPEED_FACTOR</code>*ln(2)/2), where <code>SPEED_FACTOR</code> is the 
 
356
value accessible as "Game Speed" in the game settings menu.
 
357
On single player games on a dedicated server, the value of <code>SP_SPEED_FACTOR</code>
 
358
is taken instead.
 
359
</p> 
 
360
 
 
361
<a name=><h4 align=left>Turning</h4></a>
 
362
<p align=justify>
 
363
Cycles are not allowed to make arbitrarily fast turns; mostly, this is to take away
 
364
the advantage the AI opponents would have over you, and to avoid flooding a server
 
365
with fast turn commands. The minimum time between turns is determined by <code>CYCLE_DELAY</code>.
 
366
</p>
 
367
<p align=justify>
 
368
It may be desirable to modify the minimum time between turns based on the cycle's speed;
 
369
that's what the setting <code>CYCLE_DELAY_TIMEBASED</code> does. If it is at the default value
 
370
of 1, the cycle delay works as described in the above paragraph. If it is increased,
 
371
the time between turns gets longer the faster you go, if it is decreased, the time between
 
372
turns gets shorter the faster you go. At 0, two fast consecutive turns will approximately
 
373
have the same distance from each other.
 
374
</p>
 
375
<p align=justify>
 
376
At every turn, your cycle loses a bit of speed; how much is determined by 
 
377
<code>CYCLE_TURN_SPEED_FACTOR</code>. At every turn, your speed gets multiplied with this value.
 
378
Set it to 1 to disable the turn slowdown.
 
379
</p>
 
380
<p align=justify>
 
381
When you turn away from a wall, your cycle can get an instant speed boost or speed drain
 
382
from it. The formula for your speed after the break is
 
383
<pre>speed_after=speed_before + (F(D)/F(0)) * ( CYCLE_BOOST_? + ( CYCLE_BOOSTFACTOR_? - 1 ) * speed_before )
 
384
</pre>where ? is, as for the different acceleration effects of walls, either SELF, TEAM, ENEMY or
 
385
RIM for your own walls, teammates' walls, enemy walls or rim walls that you break away from, and
 
386
F(D) is the same function that is used in the wall acceleration formula.</p>
 
387
<p align=justify>
 
388
In words: If you break away from a wall after grinding it really hard, your speed gets multiplied
 
389
with CYCLE_BOOSTFACTOR_?, then CYCLE_BOOST_? is added. If you're not really close, the boost
 
390
is scaled down with the same profile as the continuous wall acceleration.</p>
 
391
 
 
392
 
 
393
<a name=><h4 align=left>Rubber</h4></a>
 
394
<p align=justify>
 
395
The <code>CYCLE_RUBBER</code> setting is a niceness thing, especially useful
 
396
in an internet game where player prediction is poor: if you
 
397
hit a wall, you are not directly deleted; you are stopped for a
 
398
short time and your supply of "rubber" is decreased. If you manage
 
399
to turn fast enough, you won't die. Rubber has three aspects: how close
 
400
you can get to walls, how fast you do so, and how long long you survive.</p>
 
401
<p align=justify>
 
402
How close you can get to a wall is determined by the <code>CYCLE_RUBBER_MINDISTANCE</code>
 
403
family of settings. All contributions are summed up. The basic one is
 
404
<code>CYCLE_RUBBER_MINDISTANCE</code> itself: you won't be able to get closer to a wall
 
405
than that. <code>CYCLE_RUBBER_MINDISTANCE_RATIO</code> is there to avoid trouble with inexact
 
406
internal calculations: The lenght of the wall in front of you is multiplied by
 
407
this value, then added to the effect of <code>CYCLE_RUBBER_MINDISTANCE</code>. The next
 
408
two contributions influence gameplay: <code>CYCLE_RUBBER_MINDISTANCE_RESERVOIR</code> gets
 
409
multiplied with the rubber you have left to burn. If your rubber meter
 
410
shows no rubber used, the effect is in full force; if your rubber meter is almost full,
 
411
there is virtually no effect. <code>CYCLE_RUBBER_MINDISTANCE_RESERVOIR</code> makes grinds
 
412
where you use up all your rubber deeper. <code>CYCLE_RUBBER_MINDISTANCE_UNPREPARED</code> gets
 
413
added if your last turn was only a short time ago; if you turn right into a wall, it is
 
414
at full effect; if your last turn was more than <code>CYCLE_RUBBER_MINDISTANCE_PREPARATION</code>
 
415
seconds ago, the effect gets weakened approximately inversely proportional to the time
 
416
since the last turn.
 
417
</p>
 
418
<p align=justify>
 
419
All these <code>MINDISTANCE</code> settings get overridden if your last turn was already very close
 
420
to a wall (like the maneuvers known as 180s and adjusts), your cycle is allowed to
 
421
get closer to the wall by the factor <code>CYCLE_RUBBER_MINADJUST</code> before they kick in.
 
422
</p>
 
423
<p align=justify>
 
424
How fast you are allowed to approach a wall is determined by <code>CYCLE_RUBBER_SPEED</code>.
 
425
It's a logarithmic speed; you will be able to make half the distance to a wall
 
426
in no less than T=ln(2)/<code>CYCLE_RUBBER_SPEED</code> seconds, make the next quarter
 
427
in another T seconds, and so on; you never reach the wall completely.
 
428
Rubber usage gets activated only if your current speed is larger than the speed determined
 
429
by this (&lt;distance_to_wall&gt;*<code>CYCLE_RUBBER_SPEED</code>) at every moment).
 
430
On 0.2.7.0 and earlier, the corresponding code was dependant on your framerate;
 
431
the new code behaves approximately like the old code at <code>CYCLE_RUBBER_SPEED</code>/ln(2) fps.
 
432
ln(2) is about 0.7.
 
433
</p>
 
434
<p align=justify>
 
435
The main variable that determines how long you survive is
 
436
<code>CYCLE_RUBBER</code>. In network games, your ping (in seconds) is multiplied by
 
437
<code>CYCLE_PING_RUBBER</code> and added on top of that. How much rubber is used
 
438
is based on the distance you would have covered had the rubber not stopped
 
439
you or slowed you down. If you use up all your rubber, it loses its effect
 
440
and usually you die. Your reservoir gets refilled slowly over a timescale
 
441
determined by <code>CYCLE_RUBBER_TIME</code> (defaults to 10 seconds).
 
442
</p>
 
443
<p align=justify>
 
444
Since rubber is based on distance, it is used up faster if you go faster.
 
445
You can change that with <code>CYCLE_RUBBER_TIMEBASED</code>; set it to 1 to base
 
446
the rubber usage on time instead. You can also set it to 2 to make rubber
 
447
even more effective as you go faster, or -1 to make it more ineffective
 
448
than usual when you go fast. Intermediate values are also allowed.
 
449
</p>
 
450
<p align=justify>
 
451
How would you call it if you drive parallel close to a wall, then turn towards it?
 
452
I'd call it stupid. To punish this stupidity, the rubber efficency can be modified
 
453
for a short time after each turn (so more rubber is used than usual).
 
454
To activate this, set <code>CYCLE_RUBBER_DELAY</code>
 
455
to a positive value. For <code>CYCLE_RUBBER_DELAY</code>*<code>CYCLE_DELAY</code> seconds after every
 
456
turn, the rubber efficiency gets multiplied with <code>CYCLE_RUBBER_DELAY_BONUS</code>. Values
 
457
smaller than 1 will increase rubber usage, a value of zero deactivates the rubber
 
458
protection completely for that time.
 
459
</p>
 
460
 
 
461
<p align=justify>
 
462
Summary: You're certainly confused about all these settings for such a simple feature;
 
463
the most important ones to play with first are <code>CYCLE_RUBBER</code>, <code>CYCLE_RUBBER_SPEED</code>
 
464
(set it to something low to feel its effect) and <code>CYCLE_RUBBER_TIME</code>. They determine
 
465
how long you survive, how fast you grind, and how fast your rubber replenishes (in that
 
466
order). An alternative description can be found in 
 
467
<a href="http://forums.armagetronad.net/viewtopic.php?t=1774" target=_top><strong>this forum thread</strong></a>.
 
468
</p>
 
469
 
 
470
<a name=><h3 align=left>Camera Modes</h3></a>
 
471
 
 
472
<p align=justify>
 
473
A special feature are the <code>CAMERA_FORBID_*</code> settings; 
 
474
if you think for
 
475
example that using the free floating camera is cheating, simply
 
476
set <code>CAMERA_FORBID_FREE</code> to 1 on your server; 
 
477
none of the clients will
 
478
then be able to use the free camera. (Of course, it is possible
 
479
for a modified client to cheat at this point, using the forbidden
 
480
camera perspectives anyway.) Try a match with all but the internal
 
481
camera disabled :-)
 
482
</p>
 
483
 
 
484
<p align=justify>Likewise, you can override the glance settings with server defined glance
 
485
settings with CAMERA_OVERRIDE_CUSTOM_GLANCE 1 for all cameras or just for the server defined
 
486
custom camera with CAMERA_OVERRIDE_CUSTOM_GLANCE_SERVER_CUSTOM 1. You can forbid custom
 
487
glancing settings alltogether with CAMERA_FORBID_CUSTOM_GLANCE 1. Note that only relatively
 
488
new clients (0.2.8.3 or later) respect these settings.</p>
 
489
 
 
490
<a name=><h3 align=left>Maps</h3></a>
 
491
<p align=justify>
 
492
New in 0.2.8 is the possibility to select an arena to fight in. It is still a bit experimental
 
493
(not because the arena code itself is buggy, but because the AI opponents have not been adapted),
 
494
and to stress this, it is not yet possible to choose the map in the menu. Also, apologies
 
495
for the
 
496
quite strict rules server administrators need to follow (see below), we're working on automating
 
497
some of the administrative overhead.
 
498
</p>
 
499
 
 
500
<p align=justify>
 
501
To change the map, set the <code>MAP_FILE</code> variable to the path to the map. Maps are searched in the
 
502
<a href="config.html#resource" target=_top>resource folders</a>. There are example setting lines for
 
503
all the included maps in settings.cfg, you just have to uncomment the appropriate lines.
 
504
</p>
 
505
 
 
506
<p align=justify>
 
507
If you want to override a map's number of driving directions, you can do so with <code>ARENA_AXES</code>.
 
508
</p>
 
509
 
 
510
<p align=justify>
 
511
If you want to create your own map, you should read the <a href="Howto-Maps.txt" target=_top>Maps HOWTO</a>.
 
512
</p>
 
513
 
 
514
<a name=><h4 align=left>Automatic downloading</h4></a>
 
515
<p align=justify>
 
516
Maps will be automatically downloaded from the internet if they are not available locally. First,
 
517
the URI given in the setting <code>MAP_URI</code> is tried; if that fails, the URI 
 
518
<code>RESOURCE_REPOSITORY/MAP_FILE</code> is used.
 
519
</p>
 
520
 
 
521
<p align=justify>
 
522
<strong>Important for server administrators:</strong> MAP_FILE needs to follow strict rules since
 
523
it determines the position the map will be stored under for all clients that connect to your
 
524
server. Not following these simple guidelines will mess up your clients' automatic resource
 
525
directory and they'll blame the development team for not providing a mechanism that
 
526
magically puts maps into the right place (and they are right with that, but that's
 
527
another stroy). Anyway, the guidelines: <code>MAP_FILE</code> should be of the form
 
528
AuthorName/[SubDirectory/]ResourceName-VersionNumber.aamap.xml, and usually, the attributes
 
529
of the Map tag will tell you what you should use for AuthorName, ResourceName and
 
530
VersionNumber and, if the author chooses to be organized, the optional SubDirectory part as well.
 
531
If the map you want to use does not give you
 
532
enough information to uniquely derive <code>MAP_FILE</code> from it, ask the author. There is a python
 
533
script called <code>sortresources.py</code> that automates putting the resource files into the right place.
 
534
</p>
 
535
 
 
536
<p align=justify>Also, it should be noted that maps <strong>need</strong> to be versioned:
 
537
no two files with different content and the same VersionNumber must exist. Ever. Really confused
 
538
clients would be the result.
 
539
</p>
 
540
 
 
541
<a name=console><h2 align=left>The Console</h2></a>
 
542
<p align=justify>
 
543
All the settings you alter permanently in the .cfg-files can be
 
544
tested temporarily if you enter them at the console. To enter a
 
545
line to the console, you have to bind a key to it 
 
546
(in "Misc Stuff/Global Keyboard Configuration") and press it, of course.
 
547
The line you enter will be interpreted just as if it was read from
 
548
a config file.
 
549
if you type in an incomplete
 
550
name, you'll get a list of settings that contain that name. Just typing
 
551
the name of a setting will print the current value.
 
552
<br>
 
553
If you run a <a href=network.html#dedicated>dedicated server</a>, 
 
554
everything you type will be considered console input.  
 
555
</p>
 
556
 
 
557
<a name=><h4 align=left>Special Console Commands</h4></a>
 
558
 
 
559
<code>x</code> always is a real number, <code>n</code> an integral number,
 
560
<code>b</code> a boolean value (0=false,1=true) and <code>s</code> a string
 
561
(all the rest of the line will be read).
 
562
<table>
 
563
<tr><td valign=top><code>START_NEW_MATCH </code></td><td>reset the scores and start a new match in the next round</td></tr>
 
564
<tr><td valign=top><code>DEDICATED_IDLE x </code></td><td>Only used by the dedicated server: after running for x hours, the server takes the next opportunity (when no one is online) to quit.</td></tr>
 
565
<tr><td valign=top><code>QUIT or EXIT </code></td><td>shuts the server down</td></tr>
 
566
<tr><td valign=top><code>KICK s </code></td><td>Kicks player s from the server</td></tr>
 
567
<tr><td valign=top><code>CENTER_MESSAGE/CONSOLE_MESSAGE s </code></td><td>Prints a message for all connected clients at the
 
568
center of the screen/on the console</td></tr>
 
569
<tr><td valign=top><code>SAY </code></td><td>Dedicated server only: let the server administrator say something</td></tr>
 
570
</table>
 
571
<a name=><h4 align=left>Other Console Commands</h4></a>
 
572
<table>
 
573
<tr><td valign=top><code>CYCLE_SPEED x </code></td><td>basic cycle speed (m/s)</td></tr>
 
574
<tr><td valign=top><code>CYCLE_START_SPEED x </code></td><td>cycle speed at startup</td></tr>
 
575
<tr><td valign=top><code>CYCLE_ACCEL x </code></td><td>acceleration multiplicator</td></tr>
 
576
<tr><td valign=top><code>CYCLE_ACCEL_OFFSET x </code></td><td>acceleration offset (higher means lower acceleration)</td></tr>
 
577
<tr><td valign=top><code>CYCLE_DELAY x </code></td><td>minimum time between turns</td></tr>
 
578
<tr><td valign=top><code>CYCLE_WALL_NEAR x </code></td><td>when is a wall near?</td></tr>
 
579
<tr><td valign=top><code>CYCLE_SOUND_SPEED x </code></td><td>sound speed divisor; the speed at which the cycle sound is played at normal speed</td></tr> 
 
580
<tr><td valign=top><code>CYCLE_BRAKE x </code></td><td>brake strength</td></tr>
 
581
<tr><td valign=top><code>CYCLE_RUBBER x </code></td><td>niceness when hitting a wall</td></tr>
 
582
<tr><td valign=top><code>CYCLE_PING_RUBBER x </code></td><td>niceness when hitting a wall, influence of your ping</td></tr>
 
583
<tr><td valign=top><code>FLOOR_RED/GREEN/BLUE x </code></td><td>floor colour (without moviepack)</td></tr>
 
584
<tr><td valign=top><code>FLOOR_MIRROR_INT x </code></td><td>floor mirror intensity(if enabled)</td></tr>
 
585
<tr><td valign=top><code>GRID_SIZE x </code></td><td>distance of the grid lines</td></tr>
 
586
<tr><td valign=top><code>CAMERA_FORBID_SMART b </code></td><td>forbid smart camera</td></tr>
 
587
<tr><td valign=top><code>CAMERA_FORBID_IN b </code></td><td>forbid internal camera</td></tr>
 
588
<tr><td valign=top><code>CAMERA_FORBID_FREE b </code></td><td>forbid free camera</td></tr>
 
589
<tr><td valign=top><code>CAMERA_FORBID_FOLLOW b </code></td><td>forbid fixed external camera</td></tr>
 
590
<tr><td valign=top><code> </code></td><td></td></tr>
 
591
<tr><td valign=top><code>SCORE_WIN n </code></td><td>points you gain for being last one alive</td></tr>
 
592
<tr><td valign=top><code>SCORE_SUICIDE n </code></td><td>points you gain for every stupid death 
 
593
(race into the rim/your own wall); should be negative</td></tr>
 
594
<tr><td valign=top><code>SCORE_KILL n </code></td><td>points you gain for everyone racing into your wall</td></tr>
 
595
<tr><td valign=top><code>SCORE_DIE n </code></td><td>points you gain for every time you race into someone's wall (should be negative)</td></tr>
 
596
<tr><td valign=top><code> </code></td><td></td></tr>
 
597
<tr><td valign=top><code>LIMIT_SCORE n </code></td><td>score limit (all limits for one match)</td></tr>
 
598
<tr><td valign=top><code>LIMIT_ROUNDS n </code></td><td>maximum number of rounds to play</td></tr>
 
599
<tr><td valign=top><code>LIMIT_TIME n </code></td><td>maximum time (in minutes)</td></tr>
 
600
<tr><td valign=top><code>MESSAGE_OF_DAY_1/2/3/4 s </code></td><td>message lines sent to the clients upon connection</td></tr>
 
601
<tr><td valign=top><code> </code></td><td></td></tr>
 
602
<tr><td valign=top><code>COLOR_STRINGS b </code></td><td>draw strings in colour?</td></tr>
 
603
</table>
 
604
 
 
605
<p align=justify><a name=sphh>Settings for single player highscore hunt on this server:</a>
 
606
<table>
 
607
<tr><td valign=top><code>SP_SCORE_WIN n </code></td><td>points you gain for being last one alive</td></tr>
 
608
<tr><td valign=top><code>SP_LIMIT_ROUNDS n </code></td><td>max number of rounds to play</td></tr>
 
609
<tr><td valign=top><code>SP_LIMIT_TIME n </code></td><td>max time (in minutes)</td></tr>
 
610
<tr><td valign=top><code>SP_AIS n </code></td><td>number of opponents you will face</td></tr>
 
611
</table>
 
612
</p>
 
613
 
 
614
<p align=justify>Ladder league constants:
 
615
<table>
 
616
<tr><td valign=top><code>LADDER_PERCENT_BET x </code></td><td>percentage of your score to be put in the pot</td></tr>
 
617
<tr><td valign=top><code>LADDER_MIN_BET x </code></td><td>minimum credits to be put in the pot</td></tr>
 
618
<tr><td valign=top><code>LADDER_TAX x </code></td><td>percentage the IRS takes from the pot</td></tr>
 
619
<tr><td valign=top><code>LADDER_LOSE_PERCENT_ON_LOAD x </code></td><td>you lose this percentage of your
 
620
score every time the server is restarted</td></tr>
 
621
<tr><td valign=top><code>LADDER_LOSE_MIN_ON_LOAD x </code></td><td>but minimum this value</td></tr>
 
622
<tr><td valign=top><code>LADDER_GAIN_EXTRA x </code></td><td>the winner gets his ping+ping charity
 
623
(in seconds) times this value extra</td></tr>
 
624
</table>
 
625
</p>
 
626
 
 
627
<a name=><h2 align=left>Complete List</h2></a>
 
628
<p align=justify>
 
629
A complete list of all available commands is available <a href="commands.html" target=_top>here</a>.
 
630
</p>
 
631
 
 
632
<a name=resource><h2 align=left>Resource Path</h2></a>
 
633
<p align=justify>
 
634
The directories searched for resources are the explicit resource path given by 
 
635
the <code>--resourcedir</code> command line
 
636
argument and the <strong>resource</strong> subdirectories of the systemwide data directories
 
637
 and user data directories. The 
 
638
<strong>included</strong> subdirectories of these resource directories are searched as well, but you should
 
639
not put files in there, they are reserved for resources we include in our distribution. 
 
640
<br>
 
641
Lastly, there is
 
642
a directory reserved for resources automatically downloaded from the network; usually, it is the
 
643
directory called <strong>resource/automatic</strong> under the user data directory, but falls back to
 
644
the same subdirectory of the system data directory and can be overridden by the 
 
645
<code>--autoresourcedir</code> command line argument. The <strong>automatic</strong> subdirectory of the explicit
 
646
resource path given with <code>--resourcedir</code> overrides the default automatic resource
 
647
path as well.
 
648
</p>
 
649
 
 
650
 
 
651
<br>
 
652
 
 
653
 
 
654
 
 
655
<p align=center>This document was created by
 
656
<a href="http://armagetron.sf.net/contact.html" target=_top><strong>Manuel Moos</strong></a>
 
657
</p>
 
658
 
 
659
<p align=center>
 
660
Last modification: Jul 18 2008
 
661
</p>
 
662
<p align=center><!--#spaceportsbanner--></p>
 
663
 
 
664
 
 
665
 
 
666
<table width="90%" align=center>
 
667
<tr>
 
668
 
 
669
 
 
670
 
 
671
 
 
672
 
 
673
 
 
674
 
 
675
 
 
676
 
 
677
 
 
678
 
 
679
 
 
680
 
 
681
 
 
682
 
 
683
 
 
684
<td align=center width="15%">
 
685
<a href="index.html" target="_top">First Start</a>
 
686
</td>
 
687
 
 
688
 
 
689
 
 
690
 <td align=center width="15%">
 
691
<a href="install_linux.html" target="_top"> Installation</a>
 
692
</td>
 
693
      
 
694
<td align=center width="15%">
 
695
<a href="network.html" target="_top">Network Play</a>
 
696
</td>
 
697
 
 
698
<td align=center width="15%">
 
699
<strong>Configuration</strong> 
 
700
</td>
 
701
 
 
702
<td align=center width="10%">
 
703
<a href="faq.html" target="_top">FAQ</a>
 
704
</td>
 
705
 
 
706
<td align=center width="15%">
 
707
<a href="compile.html" target="_top">Redistribution</a>
 
708
</td>
 
709
 
 
710
 
 
711
</tr>
 
712
</table>
 
713
 
 
714
 
 
715
</body>
 
716
</html>
 
717
 
 
718