This file is indexed.

/usr/share/doc/armagetronad-common/html/config.html is in armagetronad-common 0.2.8.3.2-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 







































 
 

















<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   <meta name="date" content="2011-09-11T12:50:24+01:00">

   <meta name="author" content="Manuel Moos">
   <title>Armagetron Advanced: Documentation</title>
   <meta name="description" content="Armagetron Advanced: Documentation">
</head><body>





<table width="90%" align=center>
<tr>






 
 
 







<td align=center width="15%">
<a href="index.html" target="_top">First Start</a>
</td>

 <td align=center width="15%">
<a href="install_windows.html" target="_top">Windows Installation</a>
</td>
  
 <td align=center width="15%">
<a href="install_macosx.html" target="_top">Mac OS X Installation</a>
</td>
    
 <td align=center width="15%">
<a href="install_linux.html" target="_top">Linux Installation</a>
</td>
      
<td align=center width="15%">
<a href="network.html" target="_top">Network Play</a>
</td>

<td align=center width="15%">
<strong>Configuration</strong> 
</td>

<td align=center width="10%">
<a href="faq.html" target="_top">FAQ</a>
</td>

<td align=center width="15%">
<a href="compile.html" target="_top">Redistribution</a>
</td>


</tr>
</table>



<a name=><h1 align=center>Configuration</h1></a>

All the normal user settings of Armagetron Advanced are configurable in
the menu system. Since it is quite easy to get lost, here is a
(not always up-to-date) map of all submenus (the menu items have
an auto help display below if you don't touch any keys for some seconds,
 so to let you keep the overview here, I omit the simple items):





<a name=><h4 align=left>Main Menu</h4></a>
<ul>
<li><strong>Game</strong> (start and setup a game)</li>
<ul>
<li><strong>Local Game</strong> (Starts a local game)</li>
<li><strong>Network Game</strong> (Connects to or creates a network game)</li>
<li><strong>Game Setup</strong> (Sets your favourite single player game mode: number of AI opponents)</li>
</ul>
<li><strong>Player Setup</strong> (Player customisation: keyboard input, camera setup, multiplayer
mode on one computer)</li>
<ul>
<li><strong>Player 1-4</strong> (the settings for this player)</li>
<ul>
<li><strong>Input Configuration</strong> (keyboard and mouse setup)</li>
<li><strong>Camera Input Configuration</strong> (keyboard and mouse setup for camera controls)</li>
<li><strong>Camera Setup</strong> (camera mode options)</li>
<li><strong>Instant Chat</strong> (things you can say with one keystroke)</li>
</ul>
<li><strong>Assign Viewports To Players</strong> (which player sees himself on which part of
the screen)</li>
</ul>
<li><strong>System Setup</strong> (Configure sound)</li>
<ul>
<li><strong>Display Settings</strong> (screen resolution and graphic details/preferences)</li>
<ul>
<li><strong>Screen Mode</strong> (resolution and windowed/fullscreen selection)</li>
<li><strong>Preferences</strong> (things that depend more on your personal taste)</li>
<li><strong>Detail Settings</strong> (things that affect visual quality and depend on your
system's OpenGL power)</li>
<li><strong>Performance Tweaks</strong> (settings that increase graphics speed, but
may not work on your system)</li>
</ul>
<li><strong>Sound Settings</strong> (sound quality)</li>
<li><strong>Misc Stuff</strong> (things that did not fit anywhere else: Moviepack, console text
output, menu wrap option and global keyboard configuration)</li>
<ul>
<li><strong>Global Keyboard Configuration</strong> (keyboard setup for player-independent functions (console, scores))</li>
<li><strong>Language settings</strong> (Choose the language of Armagetron Advanced here)</li>
</ul>
</ul>
</ul>



<a name=new><a name=><h3 align=left>Game Rule Settings</h3></a></a>
<p align=justify>
Some of the maybe less obvious game settings in "Game Setup" available since version 0.2 are explained here:
<ul>
<li>The AIs come in various intelligence grades. Select it in the "AI IQ" menu item.</li>
<li>Explosions can blow away walls. Select in "Blast Radius" how much destruction they bring.</li>
<li>Cycle walls can be of finite length (a la snake). Choose in "Wall Length" how long they should be.</li>
<li>The delay between the a cycle explosion and the disappearing of its wall can be configured in "Wall Delay".</li>
<li>Arena size and overall game speed can be adjusted in "Arena Size" and "Speed". Note that the setting here is logarithmic; that
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>
</ul>
Only important for multiplayer games:
<ul>
<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>
<li>You can control team ballance with the "Max imbalance" and "Ballance with AIs" settings.</li>
</ul>
</p>

<a name=recording><h2 align=left>Debug Recording</h2></a>
<p align=justify>
Armagetron Advanced supports recording whole program sessions for debugging and performance tuning.
</p>
<a name=><h3 align=left>Usage</h3></a>
<p align=justify>
To record a program session, use the command line parameter <code>--record &lt;filename&gt;</code>;
this will store the recording in the file <code>&lt;filename&gt;</code> in the current directory.
A suggested file extension would be <code>.rec</code>.
</p>
<p align=justify>
To playback a recording, use the command line parameter <code>--playback &lt;filename&gt;</code>.
If you want to skip ahead to the interesting part,
you can do so by giving the additional parameter <code>--fastforward &lt;time&gt;</code>.
While playing back a client session, the current time will always be 
displayed in the upper right corner of the screen.
</p>
<p align=justify>
During playback, input from the keyboard is not disabled.
You can use it safely for nonessential input,
like controlling the camera or toggling the score display.
However, issuing cycle turn commands is likely to break the playback.
It is possible to combine both playback and recording arguments on the command line;
this gives you rudimentary recording editing possibilities.
</p>
<p align=justify>
The command line switch <code>--benchmark</code> plays the recording 
back frame by frame as it was recorded and give performance statistics at the end of the run. 
Without this option, the playback will try to match the real speed.
</p>

<p align=justify>
On MS Windows, to give the Armagetron Advanced command line arguments, open up a command console (aka dos box)
and type (if you have installed Armagetron Advanced into E:\Program Files\armagetronad-dedicated):
<pre>
E:\
cd E:\Program Files\armagetronad-dedicated
./armagetronad-dedicated &lt;command line arguments&gt;
</pre>
But you don't have to go through that hassle; there are three start menu entries that record
to a file on your desktop and play it back normally or in benchmarking mode.
</p>

<a name=><h3 align=left>Background</h3></a>
<p align=justify>
Recording works by storing all external input
(keypresses, time measurements, file reads and network traffic)
in a file and feeding the stored input to the program on playback.
Due to the purpose and the implementation, there are limitations: 
It is unlikely that a recording done with one version will play back on another version.
It often happens that even with the same version, different builds
(Windows vs. Linux, different GCC versions used to compile, PC vs. Mac, Debug vs. Optimized)
produce incompatible playbacks because of subtle
differences in the way numbers are treated by different processors,
compilers and operating systems.
</p>
<a name=><h3 align=left>Protect Your Passwords</h3></a>
<p align=justify>
Since all network traffic is logged and the ingame admin password is currently sent unencrypred,
it is not a good idea to publish server recordings where you or anyone else logs in as admin.
The same holds for a client session recording where you log in anywhere; remember that all your
keypresses are recorded without exception.
</p>
<a name=><h3 align=left>Primary Use: Bug Reports</h3></a>
<p align=justify>
Sometimes, when you report a bug, the team may ask you do send a recording of
the bug happening.
It is then most useful if you do your recording while you have
VSYNC enabled in your video driver settings
(so your framerate and the rate of recording is limited by your video refresh,
which makes the recording smaller and faster to fast forward through) and spark rendering disabled.
Please try to make the bug happen as soon as possible. 
Because of the limitations of the recordings, we'll also
need to know the exact version and build you are using.
A screenshot or even a series of screenshots edited by you that show us what you think is
wrong also helps greatly;
if you make them while playing back your recording,
we have the added benefit that we see the timestamp and know where to fast forward to.
</p>
<a name=><h3 align=left>Secondary Use: Demo Recording</h3></a>
<p align=justify>
If you want to use a recording to show off,
it is best to do record it on the client in a network
session even if you just want to demonstrate your superior AI killing ability.
This increases the chances for compatibility greatly because all game physics decisions are
made on the server and stored in the recording in the form of the network traffic.
Keep the limitations in mind, though;
it is not a bug if this recording does not play back
on anything but your own machine and the exact version it was recorded with.
</p>


<a name=files><h2 align=left>Advanced Configuration</h2></a>

<p align=justify>
Take a look at the files
<strong>settings.cfg</strong> and <strong>settings_dedicated.cfg</strong> for the dedicated server
(best save all your changes to 
<strong>autoexec.cfg</strong> if you don't want the next
release of Armagetron Advanced to overwrite them). They contain a lot of settings
inaccessible from the menu system. All relevant settings are synced from the
server to the connected clients.
You can place comments preceeded by <code>#</CODE> anywhere in these files.
</p>

<p align=justify>
The settings that affect only the visual appearance (<code>FLOOR_*</code> ...)
are not transferred; It stays a matter of taste if you want the floor
red or yellow.
</p>

<a name=><h3 align=left>Game Physics</h3></a>
<a name=><h4 align=left>Speed</h4></a>
<p align=justify>
The game is too slow for you? Then 
play a bit with <code>CYCLE_SPEED</code> and all the other
nice variables and see what happens.
Not all possible setting items are included in these files, you can add everything
you find in <a href="commands.html" target=_top>this unsorted document</a>.
</p>

<p align=justify>
The base acceleration in an open field is <pre>(CYCLE_SPEED-current speed) * f</pre>
where f is
<code>CYCLE_SPEED_DECAY_BELOW</code> if the current speed is smaller than <code>CYCLE_SPEED</code> resp.
<code>CYCLE_SPEED_DECAY_ABOVE</code> if it is bigger. The effect is that the cycle's speed will
approach <code>CYCLE_SPEED</code> over time. The bigger the constants, the faster the approach.
</p>

<p align=justify>
The acceleration caused by the wall at distance <code>D</code> is
<pre>acceleration=CYCLE_ACCEL * F(D)</pre>
with
<pre>
F(D) = 1 / (CYCLE_ACCEL_OFFSET + D) 
     - 1 / (CYCLE_ACCEL_OFFSET + CYCLE_WALL_NEAR)
</pre>
if the wall is closer than <code>CYCLE_WALL_NEAR</code>. 
the stuff in the second
line just makes sure that the acceleration is 0 if 
<code>D=CYCLE_WALL_NEAR</code>, so there are no "jumps".
Depending on the nature of the wall (whether it belongs to you, your teammate, 
your enemy or is the arena rim), the acceleration gets multiplied with 
<code>CYCLE_ACCEL_SELF</code>, <code>_TEAM</code> resp. <code>_ENEMY</code> or <code>_RIM</code>. If your cycle
is stuck between one of your walls and a wall of any other type, your total
acceleration by walls gets multiplied by <code>CYCLE_ACCEL_SLINGSHOT</code>. If you drive
between two walls that are not your own, your acceleration gets multiplied with
<code>CYCLE_ACCEL_TUNNEL</code>.
</p>

<p align=justify>
Furthermore, to make the overall speed feeling configurable without disturbing the
tuning of the values with respect to each other, <code>CYCLE_SPEED</code> and <code>CYCLE_ACCEL</code>
are multiplied by exp(<code>SPEED_FACTOR</code>*ln(2)/2), where <code>SPEED_FACTOR</code> is the 
value accessible as "Game Speed" in the game settings menu.
On single player games on a dedicated server, the value of <code>SP_SPEED_FACTOR</code>
is taken instead.
</p> 

<a name=><h4 align=left>Turning</h4></a>
<p align=justify>
Cycles are not allowed to make arbitrarily fast turns; mostly, this is to take away
the advantage the AI opponents would have over you, and to avoid flooding a server
with fast turn commands. The minimum time between turns is determined by <code>CYCLE_DELAY</code>.
</p>
<p align=justify>
It may be desirable to modify the minimum time between turns based on the cycle's speed;
that's what the setting <code>CYCLE_DELAY_TIMEBASED</code> does. If it is at the default value
of 1, the cycle delay works as described in the above paragraph. If it is increased,
the time between turns gets longer the faster you go, if it is decreased, the time between
turns gets shorter the faster you go. At 0, two fast consecutive turns will approximately
have the same distance from each other.
</p>
<p align=justify>
At every turn, your cycle loses a bit of speed; how much is determined by 
<code>CYCLE_TURN_SPEED_FACTOR</code>. At every turn, your speed gets multiplied with this value.
Set it to 1 to disable the turn slowdown.
</p>
<p align=justify>
When you turn away from a wall, your cycle can get an instant speed boost or speed drain
from it. The formula for your speed after the break is
<pre>speed_after=speed_before + (F(D)/F(0)) * ( CYCLE_BOOST_? + ( CYCLE_BOOSTFACTOR_? - 1 ) * speed_before )
</pre>where ? is, as for the different acceleration effects of walls, either SELF, TEAM, ENEMY or
RIM for your own walls, teammates' walls, enemy walls or rim walls that you break away from, and
F(D) is the same function that is used in the wall acceleration formula.</p>
<p align=justify>
In words: If you break away from a wall after grinding it really hard, your speed gets multiplied
with CYCLE_BOOSTFACTOR_?, then CYCLE_BOOST_? is added. If you're not really close, the boost
is scaled down with the same profile as the continuous wall acceleration.</p>


<a name=><h4 align=left>Rubber</h4></a>
<p align=justify>
The <code>CYCLE_RUBBER</code> setting is a niceness thing, especially useful
in an internet game where player prediction is poor: if you
hit a wall, you are not directly deleted; you are stopped for a
short time and your supply of "rubber" is decreased. If you manage
to turn fast enough, you won't die. Rubber has three aspects: how close
you can get to walls, how fast you do so, and how long long you survive.</p>
<p align=justify>
How close you can get to a wall is determined by the <code>CYCLE_RUBBER_MINDISTANCE</code>
family of settings. All contributions are summed up. The basic one is
<code>CYCLE_RUBBER_MINDISTANCE</code> itself: you won't be able to get closer to a wall
than that. <code>CYCLE_RUBBER_MINDISTANCE_RATIO</code> is there to avoid trouble with inexact
internal calculations: The lenght of the wall in front of you is multiplied by
this value, then added to the effect of <code>CYCLE_RUBBER_MINDISTANCE</code>. The next
two contributions influence gameplay: <code>CYCLE_RUBBER_MINDISTANCE_RESERVOIR</code> gets
multiplied with the rubber you have left to burn. If your rubber meter
shows no rubber used, the effect is in full force; if your rubber meter is almost full,
there is virtually no effect. <code>CYCLE_RUBBER_MINDISTANCE_RESERVOIR</code> makes grinds
where you use up all your rubber deeper. <code>CYCLE_RUBBER_MINDISTANCE_UNPREPARED</code> gets
added if your last turn was only a short time ago; if you turn right into a wall, it is
at full effect; if your last turn was more than <code>CYCLE_RUBBER_MINDISTANCE_PREPARATION</code>
seconds ago, the effect gets weakened approximately inversely proportional to the time
since the last turn.
</p>
<p align=justify>
All these <code>MINDISTANCE</code> settings get overridden if your last turn was already very close
to a wall (like the maneuvers known as 180s and adjusts), your cycle is allowed to
get closer to the wall by the factor <code>CYCLE_RUBBER_MINADJUST</code> before they kick in.
</p>
<p align=justify>
How fast you are allowed to approach a wall is determined by <code>CYCLE_RUBBER_SPEED</code>.
It's a logarithmic speed; you will be able to make half the distance to a wall
in no less than T=ln(2)/<code>CYCLE_RUBBER_SPEED</code> seconds, make the next quarter
in another T seconds, and so on; you never reach the wall completely.
Rubber usage gets activated only if your current speed is larger than the speed determined
by this (&lt;distance_to_wall&gt;*<code>CYCLE_RUBBER_SPEED</code>) at every moment).
On 0.2.7.0 and earlier, the corresponding code was dependant on your framerate;
the new code behaves approximately like the old code at <code>CYCLE_RUBBER_SPEED</code>/ln(2) fps.
ln(2) is about 0.7.
</p>
<p align=justify>
The main variable that determines how long you survive is
<code>CYCLE_RUBBER</code>. In network games, your ping (in seconds) is multiplied by
<code>CYCLE_PING_RUBBER</code> and added on top of that. How much rubber is used
is based on the distance you would have covered had the rubber not stopped
you or slowed you down. If you use up all your rubber, it loses its effect
and usually you die. Your reservoir gets refilled slowly over a timescale
determined by <code>CYCLE_RUBBER_TIME</code> (defaults to 10 seconds).
</p>
<p align=justify>
Since rubber is based on distance, it is used up faster if you go faster.
You can change that with <code>CYCLE_RUBBER_TIMEBASED</code>; set it to 1 to base
the rubber usage on time instead. You can also set it to 2 to make rubber
even more effective as you go faster, or -1 to make it more ineffective
than usual when you go fast. Intermediate values are also allowed.
</p>
<p align=justify>
How would you call it if you drive parallel close to a wall, then turn towards it?
I'd call it stupid. To punish this stupidity, the rubber efficency can be modified
for a short time after each turn (so more rubber is used than usual).
To activate this, set <code>CYCLE_RUBBER_DELAY</code>
to a positive value. For <code>CYCLE_RUBBER_DELAY</code>*<code>CYCLE_DELAY</code> seconds after every
turn, the rubber efficiency gets multiplied with <code>CYCLE_RUBBER_DELAY_BONUS</code>. Values
smaller than 1 will increase rubber usage, a value of zero deactivates the rubber
protection completely for that time.
</p>

<p align=justify>
Summary: You're certainly confused about all these settings for such a simple feature;
the most important ones to play with first are <code>CYCLE_RUBBER</code>, <code>CYCLE_RUBBER_SPEED</code>
(set it to something low to feel its effect) and <code>CYCLE_RUBBER_TIME</code>. They determine
how long you survive, how fast you grind, and how fast your rubber replenishes (in that
order). An alternative description can be found in 
<a href="http://forums.armagetronad.net/viewtopic.php?t=1774" target=_top><strong>this forum thread</strong></a>.
</p>

<a name=><h3 align=left>Camera Modes</h3></a>

<p align=justify>
A special feature are the <code>CAMERA_FORBID_*</code> settings; 
if you think for
example that using the free floating camera is cheating, simply
set <code>CAMERA_FORBID_FREE</code> to 1 on your server; 
none of the clients will
then be able to use the free camera. (Of course, it is possible
for a modified client to cheat at this point, using the forbidden
camera perspectives anyway.) Try a match with all but the internal
camera disabled :-)
</p>

<p align=justify>Likewise, you can override the glance settings with server defined glance
settings with CAMERA_OVERRIDE_CUSTOM_GLANCE 1 for all cameras or just for the server defined
custom camera with CAMERA_OVERRIDE_CUSTOM_GLANCE_SERVER_CUSTOM 1. You can forbid custom
glancing settings alltogether with CAMERA_FORBID_CUSTOM_GLANCE 1. Note that only relatively
new clients (0.2.8.3 or later) respect these settings.</p>

<a name=><h3 align=left>Maps</h3></a>
<p align=justify>
New in 0.2.8 is the possibility to select an arena to fight in. It is still a bit experimental
(not because the arena code itself is buggy, but because the AI opponents have not been adapted),
and to stress this, it is not yet possible to choose the map in the menu. Also, apologies
for the
quite strict rules server administrators need to follow (see below), we're working on automating
some of the administrative overhead.
</p>

<p align=justify>
To change the map, set the <code>MAP_FILE</code> variable to the path to the map. Maps are searched in the
<a href="config.html#resource" target=_top>resource folders</a>. There are example setting lines for
all the included maps in settings.cfg, you just have to uncomment the appropriate lines.
</p>

<p align=justify>
If you want to override a map's number of driving directions, you can do so with <code>ARENA_AXES</code>.
</p>

<p align=justify>
If you want to create your own map, you should read the <a href="Howto-Maps.txt" target=_top>Maps HOWTO</a>.
</p>

<a name=><h4 align=left>Automatic downloading</h4></a>
<p align=justify>
Maps will be automatically downloaded from the internet if they are not available locally. First,
the URI given in the setting <code>MAP_URI</code> is tried; if that fails, the URI 
<code>RESOURCE_REPOSITORY/MAP_FILE</code> is used.
</p>

<p align=justify>
<strong>Important for server administrators:</strong> MAP_FILE needs to follow strict rules since
it determines the position the map will be stored under for all clients that connect to your
server. Not following these simple guidelines will mess up your clients' automatic resource
directory and they'll blame the development team for not providing a mechanism that
magically puts maps into the right place (and they are right with that, but that's
another stroy). Anyway, the guidelines: <code>MAP_FILE</code> should be of the form
AuthorName/[SubDirectory/]ResourceName-VersionNumber.aamap.xml, and usually, the attributes
of the Map tag will tell you what you should use for AuthorName, ResourceName and
VersionNumber and, if the author chooses to be organized, the optional SubDirectory part as well.
If the map you want to use does not give you
enough information to uniquely derive <code>MAP_FILE</code> from it, ask the author. There is a python
script called <code>sortresources.py</code> that automates putting the resource files into the right place.
</p>

<p align=justify>Also, it should be noted that maps <strong>need</strong> to be versioned:
no two files with different content and the same VersionNumber must exist. Ever. Really confused
clients would be the result.
</p>

<a name=console><h2 align=left>The Console</h2></a>
<p align=justify>
All the settings you alter permanently in the .cfg-files can be
tested temporarily if you enter them at the console. To enter a
line to the console, you have to bind a key to it 
(in "Misc Stuff/Global Keyboard Configuration") and press it, of course.
The line you enter will be interpreted just as if it was read from
a config file.
if you type in an incomplete
name, you'll get a list of settings that contain that name. Just typing
the name of a setting will print the current value.
<br>
If you run a <a href=network.html#dedicated>dedicated server</a>, 
everything you type will be considered console input.  
</p>

<a name=><h4 align=left>Special Console Commands</h4></a>

<code>x</code> always is a real number, <code>n</code> an integral number,
<code>b</code> a boolean value (0=false,1=true) and <code>s</code> a string
(all the rest of the line will be read).
<table>
<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>
<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>
<tr><td valign=top><code>QUIT or EXIT </code></td><td>shuts the server down</td></tr>
<tr><td valign=top><code>KICK s </code></td><td>Kicks player s from the server</td></tr>
<tr><td valign=top><code>CENTER_MESSAGE/CONSOLE_MESSAGE s </code></td><td>Prints a message for all connected clients at the
center of the screen/on the console</td></tr>
<tr><td valign=top><code>SAY </code></td><td>Dedicated server only: let the server administrator say something</td></tr>
</table>
<a name=><h4 align=left>Other Console Commands</h4></a>
<table>
<tr><td valign=top><code>CYCLE_SPEED x </code></td><td>basic cycle speed (m/s)</td></tr>
<tr><td valign=top><code>CYCLE_START_SPEED x </code></td><td>cycle speed at startup</td></tr>
<tr><td valign=top><code>CYCLE_ACCEL x </code></td><td>acceleration multiplicator</td></tr>
<tr><td valign=top><code>CYCLE_ACCEL_OFFSET x </code></td><td>acceleration offset (higher means lower acceleration)</td></tr>
<tr><td valign=top><code>CYCLE_DELAY x </code></td><td>minimum time between turns</td></tr>
<tr><td valign=top><code>CYCLE_WALL_NEAR x </code></td><td>when is a wall near?</td></tr>
<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> 
<tr><td valign=top><code>CYCLE_BRAKE x </code></td><td>brake strength</td></tr>
<tr><td valign=top><code>CYCLE_RUBBER x </code></td><td>niceness when hitting a wall</td></tr>
<tr><td valign=top><code>CYCLE_PING_RUBBER x </code></td><td>niceness when hitting a wall, influence of your ping</td></tr>
<tr><td valign=top><code>FLOOR_RED/GREEN/BLUE x </code></td><td>floor colour (without moviepack)</td></tr>
<tr><td valign=top><code>FLOOR_MIRROR_INT x </code></td><td>floor mirror intensity(if enabled)</td></tr>
<tr><td valign=top><code>GRID_SIZE x </code></td><td>distance of the grid lines</td></tr>
<tr><td valign=top><code>CAMERA_FORBID_SMART b </code></td><td>forbid smart camera</td></tr>
<tr><td valign=top><code>CAMERA_FORBID_IN b </code></td><td>forbid internal camera</td></tr>
<tr><td valign=top><code>CAMERA_FORBID_FREE b </code></td><td>forbid free camera</td></tr>
<tr><td valign=top><code>CAMERA_FORBID_FOLLOW b </code></td><td>forbid fixed external camera</td></tr>
<tr><td valign=top><code> </code></td><td></td></tr>
<tr><td valign=top><code>SCORE_WIN n </code></td><td>points you gain for being last one alive</td></tr>
<tr><td valign=top><code>SCORE_SUICIDE n </code></td><td>points you gain for every stupid death 
(race into the rim/your own wall); should be negative</td></tr>
<tr><td valign=top><code>SCORE_KILL n </code></td><td>points you gain for everyone racing into your wall</td></tr>
<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>
<tr><td valign=top><code> </code></td><td></td></tr>
<tr><td valign=top><code>LIMIT_SCORE n </code></td><td>score limit (all limits for one match)</td></tr>
<tr><td valign=top><code>LIMIT_ROUNDS n </code></td><td>maximum number of rounds to play</td></tr>
<tr><td valign=top><code>LIMIT_TIME n </code></td><td>maximum time (in minutes)</td></tr>
<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>
<tr><td valign=top><code> </code></td><td></td></tr>
<tr><td valign=top><code>COLOR_STRINGS b </code></td><td>draw strings in colour?</td></tr>
</table>

<p align=justify><a name=sphh>Settings for single player highscore hunt on this server:</a>
<table>
<tr><td valign=top><code>SP_SCORE_WIN n </code></td><td>points you gain for being last one alive</td></tr>
<tr><td valign=top><code>SP_LIMIT_ROUNDS n </code></td><td>max number of rounds to play</td></tr>
<tr><td valign=top><code>SP_LIMIT_TIME n </code></td><td>max time (in minutes)</td></tr>
<tr><td valign=top><code>SP_AIS n </code></td><td>number of opponents you will face</td></tr>
</table>
</p>

<p align=justify>Ladder league constants:
<table>
<tr><td valign=top><code>LADDER_PERCENT_BET x </code></td><td>percentage of your score to be put in the pot</td></tr>
<tr><td valign=top><code>LADDER_MIN_BET x </code></td><td>minimum credits to be put in the pot</td></tr>
<tr><td valign=top><code>LADDER_TAX x </code></td><td>percentage the IRS takes from the pot</td></tr>
<tr><td valign=top><code>LADDER_LOSE_PERCENT_ON_LOAD x </code></td><td>you lose this percentage of your
score every time the server is restarted</td></tr>
<tr><td valign=top><code>LADDER_LOSE_MIN_ON_LOAD x </code></td><td>but minimum this value</td></tr>
<tr><td valign=top><code>LADDER_GAIN_EXTRA x </code></td><td>the winner gets his ping+ping charity
(in seconds) times this value extra</td></tr>
</table>
</p>

<a name=><h2 align=left>Complete List</h2></a>
<p align=justify>
A complete list of all available commands is available <a href="commands.html" target=_top>here</a>.
</p>

<a name=resource><h2 align=left>Resource Path</h2></a>
<p align=justify>
The directories searched for resources are the explicit resource path given by 
the <code>--resourcedir</code> command line
argument and the <strong>resource</strong> subdirectories of the systemwide data directories
 and user data directories. The 
<strong>included</strong> subdirectories of these resource directories are searched as well, but you should
not put files in there, they are reserved for resources we include in our distribution. 
<br>
Lastly, there is
a directory reserved for resources automatically downloaded from the network; usually, it is the
directory called <strong>resource/automatic</strong> under the user data directory, but falls back to
the same subdirectory of the system data directory and can be overridden by the 
<code>--autoresourcedir</code> command line argument. The <strong>automatic</strong> subdirectory of the explicit
resource path given with <code>--resourcedir</code> overrides the default automatic resource
path as well.
</p>


<br>



<p align=center>This document was created by
<a href="http://armagetron.sf.net/contact.html" target=_top><strong>Manuel Moos</strong></a>
</p>

<p align=center>
Last modification: Sep 11 2011
</p>
<p align=center><!--#spaceportsbanner--></p>



<table width="90%" align=center>
<tr>






 
 
 







<td align=center width="15%">
<a href="index.html" target="_top">First Start</a>
</td>

 <td align=center width="15%">
<a href="install_windows.html" target="_top">Windows Installation</a>
</td>
  
 <td align=center width="15%">
<a href="install_macosx.html" target="_top">Mac OS X Installation</a>
</td>
    
 <td align=center width="15%">
<a href="install_linux.html" target="_top">Linux Installation</a>
</td>
      
<td align=center width="15%">
<a href="network.html" target="_top">Network Play</a>
</td>

<td align=center width="15%">
<strong>Configuration</strong> 
</td>

<td align=center width="10%">
<a href="faq.html" target="_top">FAQ</a>
</td>

<td align=center width="15%">
<a href="compile.html" target="_top">Redistribution</a>
</td>


</tr>
</table>


</body>
</html>