-
Notifications
You must be signed in to change notification settings - Fork 16
/
helpSettings.dat
2214 lines (2023 loc) · 89.1 KB
/
helpSettings.dat
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
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###############################################################################
# Global settings (defined in first part of spads.conf file) #
###############################################################################
[global:lobbyHost]
Lobby server hostname
-
Hostname or IP address of the Spring lobby server
-
Hostname or IP address
-
lobby.springrts.com
[global:lobbyPort]
Lobby server port
-
Port of the Spring lobby server
-
Any valid port number
-
8200
[global:lobbyTls]
Lobby TLS mode
-
Specifies if TLS encryption must be used for the connection to the lobby server.
-
on: TLS is enabled (SPADS will exit if it can't establish a TLS encrypted connection to the lobby server)
off: TLS is disabled (SPADS will use a plaintext connection to the lobby server)
auto: TLS is enabled only if the required libraries are available
-
auto
[global:lobbyReconnectDelay]
Delay before reconnecting to lobby server
-
When SPADS is disconnected from the lobby server, it tries to reconnect immediately.
But when it fails to reconnect due to network problems, it waits this amount of seconds before trying to reconnect another time.
A value of 0 disables reconnection.
It is possible to specify a range, in this case the reconnect delay value is chosen randomly inside the range.
-
Integer: number of seconds to wait before trying to reconnect
<min>-<max>: range of seconds to wait before trying to reconnect (random delay mode)
-
30
[global:lobbyFollowRedirect]
Follow lobby server redirection
-
If enabled, SPADS will follow redirection orders from Spring lobby server.
If disabled, it will keep trying to connect to the hostname specified by [global:lobbyHost].
-
0: disabled
1: enabled
-
1
[global:lobbyLogin]
AutoHost lobby name
-
Name of the AutoHost in Spring lobby
-
Any valid lobby login
-
%lobbyLogin% (set during installation, example: "Spads")
[global:lobbyPassword]
AutoHost lobby password
-
Spring lobby password for the AutoHost account
-
Any valid lobby password
-
%lobbyPassword% (set during installation, example: "abcdefgh")
[global:localLanIp]
LAN IP of the AutoHost
-
If the AutoHost is connected to a LAN, this is the AutoHost IP address on this LAN.
This parameter is used by the Spring lobby server to allow players from the same LAN to play on this AutoHost.
-
<null>: the local LAN IP is auto-detected
*: the AutoHost isn't connected to a LAN
Any valid LAN IP address: this IP is sent to lobby server as local LAN IP
-
<null>
[global:autoHostPort]
AutoHost private port
-
UDP port used for local communication between AutoHost and Spring server
-
Any valid port number
-
8454
[global:forceHostIp]
Force hosting IP address
-
By default, Spring server detects the latest IP protocol version and the corresponding network interfaces available on your system, and use them for hosting.
But if the "forceHostIp" setting is set to a valid IP address, then Spring server will use this IP address for hosting instead of the auto-detected ones.
If you have problem with hosting on your system and if you think it's related to IPv6, you may want to try setting "forceHostIp" to "0.0.0.0".
-
<null>: the auto-detected interfaces are used for hosting
Any valid IP address: the provided IP address is used for hosting
-
<null>
[global:etcDir]
SPADS configuration directory
-
Location of SPADS configuration files. This directory path can be an absolute path or a path relative to SPADS installation directory.
-
Any readable directory
-
%etcDir% (set during installation, examples: "etc", "/var/home/spring/spads/etc", "C:\Program files\Spads\etc")
[global:varDir]
SPADS dynamic data directory
-
Location of SPADS dynamic data. This directory path can be an absolute path or a path relative to SPADS installation directory.
-
Any writable directory
-
%varDir% (set during installation, examples: "var", "/var/home/spring/spads/var", "C:\Program files\Spads\var")
[global:instanceDir]
SPADS instance-specific dynamic data directory
-
Location of SPADS instance-specific dynamic data (all SPADS instances running simultaneously on a system must use a different instance-specific directory). This directory path can be an absolute path or a path relative to [global:varDir] directory.
If you run multiple SPADS instances simultaneously from a single SPADS installation, then you need to configure this setting so that each one of these instances uses a distinct instance-specific directory (for example you can use the lobby login to distinguish them, or numbers...).
If you run only one SPADS instance from this SPADS installation, then you can leave this setting empty.
-
<null>: no instance-specific directory configured ([global:varDir] directory is used instead), so only one SPADS instance can be launched from this SPADS installation
Any writable directory: this directory is used for instance-specific data, it must be distinct for each SPADS instance launched from the same SPADS installation
-
<null>
[global:logDir]
SPADS log directory
-
Location of SPADS log files. This directory path can be an absolute path or a path relative to [global:instanceDir] directory.
-
Any writable directory
-
%logDir% (set during installation, examples: "log", "/var/home/spring/spads/var/log", "C:\Program files\Spads\var\log")
[global:bansData]
Bans data mode
-
Data storage and sharing mode for players bans.
When set to "private", the data file is stored in the [global:instanceDir] directory and is private to each SPADS instance.
When set to "shared", the data file is stored in the [global:varDir] directory by default and is shared between all SPADS instances that use the same configuration.
The default file name for the data file is "bans.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file.
-
private: bans are private to each SPADS instance and stored in the "bans.dat" file located in the [global:instanceDir] directory
shared: bans are shared between all SPADS instances that use the same configuration and stored in the "bans.dat" file located in the [global:varDir] directory
shared(<fileLocation>): bans are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the [global:varDir] directory)
-
shared
[global:mapInfoCacheData]
Map information cache data mode
-
Data storage and sharing mode for the map information cache. This cache contains map specific data such as map options, size and start positions.
When set to "private", the data file is stored in the [global:instanceDir] directory and is private to each SPADS instance.
When set to "shared", the data file is stored in the [global:varDir] directory by default and is shared between all SPADS instances that use the same configuration.
The default file name for the data file is "mapInfoCache.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file.
-
private: the map information cache is private to each SPADS instance and stored in the "mapInfoCache.dat" file located in the [global:instanceDir] directory
shared: the map information cache is shared between all SPADS instances that use the same configuration and stored in the "mapInfoCache.dat" file located in the [global:varDir] directory
shared(<fileLocation>): the map information cache is shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the [global:varDir] directory)
-
shared
[global:savedBoxesData]
Saved map start boxes data mode
-
Data storage and sharing mode for saved map start boxes.
When set to "private", the data file is stored in the [global:instanceDir] directory and is private to each SPADS instance.
When set to "shared", the data file is stored in the [global:varDir] directory by default and is shared between all SPADS instances that use the same configuration.
The default file name for the data file is "savedBoxes.dat". When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file.
-
private: saved start boxes are private to each SPADS instance and stored in the "savedBoxes.dat" file located in the [global:instanceDir] directory
shared: saved start boxes are shared between all SPADS instances that use the same configuration and stored in the "savedBoxes.dat" file located in the [global:varDir] directory
shared(<fileLocation>): saved start boxes are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the [global:varDir] directory)
-
shared
[global:trustedLobbyCertificatesData]
Trusted lobby certificates data mode
-
Data storage and sharing mode for trusted lobby certificates.
When set to "private", the data file is stored in the [global:instanceDir] directory and is private to each SPADS instance.
When set to "shared", the data file is stored in the [global:varDir] directory by default and is shared between all SPADS instances that use the same configuration.
The default file name for the data file is "trustedLobbyCertificates.dat". When using shared mode, an alternate file name/location can be provided in parentheses "shared" keyword to use a specific non-default name/location for the data file.
-
private: trusted lobby certificates are private to each SPADS instance and stored in the "trustedLobbyCertificates.dat" file located in the [global:instanceDir] directory
shared: trusted lobby certificates are shared between all SPADS instances that use the same configuration and stored in the "trustedLobbyCertificates.dat" file located in the [global:varDir] directory
shared(<fileLocation>): trusted lobby certificates are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the [global:varDir] directory)
-
shared
[global:preferencesData]
Players preferences data mode
-
Data storage and sharing mode for players preferences.
When set to "private", the data file is named "preferences.dat". It is stored in the [global:instanceDir] directory and is private to each SPADS instance.
When set to "shared", the data file is named "preferences.sqlite" by default. It is stored in the [global:varDir] directory by default and is shared between all SPADS instances that use the same configuration (this mode requires the DBD::SQLite Perl module).
When using shared mode, an alternate file name/location can be provided in parentheses after the "shared" keyword to use a specific non-default name/location for the data file.
-
private: players preferences are private to each SPADS instance and stored in the "preferences.dat" file located in the [global:instanceDir] directory
shared: players preferences are shared between all SPADS instances that use the same configuration and stored in the "preferences.sqlite" file located in the [global:varDir] directory
shared(<fileLocation>): players preferences are shared between all SPADS instances that use the same configuration and stored in the <fileLocation> file (if <fileLocation> is a relative path, it is relative to the [global:varDir] directory)
-
%preferencesData% (set during installation: "shared" if SQLite availability is detected, "private" else)
[global:sharedDataRefreshDelay]
Shared data refresh delay
-
Delay in seconds between checks for updates in shared data files. This is the maximum delay before an update performed in shared data by one SPADS instance is applied to the other instances.
A value of 0 disables periodic checks for updates in shared data files (in this case shared data are only refreshed when the instance needs to update it, to avoid overwriting changes made by other instances).
-
Integer
-
5
[global:autoUpdateRelease]
Auto-update release
-
Name of the SPADS release to auto-update to.
-
<null>: auto-update is disabled
stable: auto-update to "stable" release (latest official release)
testing: auto-update to "testing" release (public testing release)
unstable: auto-update to "unstable" release (release in development)
contrib: auto-update to "contrib" release (public testing release + unchecked external patches)
-
%release% (set during installation)
[global:autoUpdateDelay]
Auto-update delay
-
Delay in minutes between checks of SPADS repository for update.
A value of 0 disables auto-update when SPADS is running, but SPADS keeps auto-updating at start if the <autoUpdateRelease> parameter is defined.
-
Integer
-
60
[global:autoRestartForUpdate]
Auto-restart for update
-
Specifies if SPADS must check regularly if its packages have been updated, and how it must restart on update.
-
off: SPADS doesn't check if its packages have been updated, and thus never auto-restarts for update
whenEmpty: SPADS auto-restarts for update only when no game is running and battle is empty
whenOnlySpec: SPADS auto-restarts for update only when no game is running and battle is empty or only contains spectators
on: SPADS auto-restarts for update when no game is running
-
whenEmpty
[global:autoManagedSpringVersion]
Auto-managed Spring version
-
If this setting is defined, then engine version auto-management is enabled: SPADS automatically downloads and uses engine binaries matching the version/release specified (auto-downloaded binaries are stored in the directory specified by [global:autoManagedSpringDir]).
The desired Spring version can be specified as a version number directly (for example: "103.0.1-1272-g170516f", "103.0" ...), or as a release name ("stable", "testing" or "unstable"). When a version number is used, SPADS will stick to this version until the setting is changed manually. When a release name is used, SPADS will stay up to date with the corresponding official Spring release by automatically downloading and using new Spring binary files when needed (the "stable" release is the current recommended Spring version, the "testing" release is the next Spring release candidate, and the "unstable" release is the latest develop version). A check delay and an auto-restart mode can optionnaly be provided to alter default behaviour (see below).
When Spring version auto-management is enabled, [global:springServerType] must be defined to specify which type of Spring server must be used (dedicated or headless). The auto-managed Spring version setting and the custom Spring installation settings are mutually exclusive: either Spring version auto-management is enabled and the custom Spring installation settings ([global:unitsyncDir] and [global:springServer]) must not be defined, or Spring version auto-management is disabled and the custom Spring installation settings ([global:unitsyncDir] and [global:springServer]) must be defined.
Engine version auto-management can also be enabled for any Spring-based engine whose releases are stored on GitHub. In this case a GitHub-specific prefix must be added to the value described above with following format:
[GITHUB]{owner=<repositoryOwner>,name=<repositoryName>,tag=<releaseTagTemplate>,asset=<assetRegularExpresion>}
<repositoryOwner> is the name of the GitHub user/organization who owns the repository
<repositoryName> is the name of the GitHub repository containing the engine releases
<releaseTagTemplate> is the template of the tags used for the releases. It must contain the "<version>" placeholder indicating where the engine version is located in the tag name, and it can contain the "<branch>" placeholder indicating where the Git branch is located in the tag name (for multi-branch tag templates).
<assetRegularExpression> is the regular expression used to select the release asset to download and install. This regular expression can contain the "<os>" and "<bitness>" placeholders: "<os>" will be automatically replaced by the current operating system ("linux" or "windows"), and "<bitness>" will be replaced by the system bitness ("64" or "32").
As for official Spring engine, it is possible to select a specific engine version number or an engine release: the "stable" release is the release tagged "Latest" on GitHub, the "testing" release is the most recent release tagged "Pre-release" or "Latest" on GitHub, and the "unstable" release is simply the most recent release available on GitHub (ignoring release tags).
As a special case of engine auto-management from GitHub, it is also possible to use the "[RECOIL]" prefix instead of "[GITHUB]{owner=...}". The "[RECOIL]" prefix is simply a shortcut for "[GITHUB]{owner=beyond-all-reason,name=spring,tag=spring_bar_{<branch>}<version>,asset=.+_<os>-<bitness>-minimal-portable\.7z}".
When using Recoil engine, two additional rolling releases are available for engine auto-management: "bar" and "barTesting", which correspond to the versions used by official "Beyond All Reason" launcher.
-
<null>: Spring version auto-management is disabled (the custom Spring installation specified by [global:unitsyncDir] and [global:springServer] is used instead)
<springVersionNumber>: SPADS auto-downloads Spring binaries for this specific version if needed, and sticks to this version
<springRelease>: SPADS stays up to date with the selected Spring release ("stable", "testing", "unstable")
<springRelease>;<checkDelay>;<autoRestartMode>: same, with customization of check delay and auto-restart mode
<checkDelay> is the delay in minutes between Spring version checks for selected release (integer). Default is "60" for "stable" Spring release, "30" for "testing" and "15" for "unstable"
<autoRestartMode> specifies if and when SPADS must auto-restart after Spring release updates, allowed values: "off", "whenEmpty", "whenOnlySpec", "on". Default is "whenEmpty"
[GITHUB]{owner=<repositoryOwner>,name=<repositoryName>,tag=<releaseTagTemplate>,asset=<assetRegularExpresion>}<engineVersionNumberOrRelease>
[RECOIL]<engineVersionNumberOrRelease>
-
%autoManagedSpringVersion% (set during installation)
[global:autoManagedSpringDir]
Auto-managed Spring directory
-
Location of the Spring binary files downloaded automatically by SPADS when Spring version auto-management is enabled (cf [global:autoManagedSpringVersion]). This directory path can be an absolute path or a path relative to [global:varDir] directory.
-
Any writable directory
-
spring
[global:springConfig]
Spring config file path
-
Absolute path of the main Spring configuration file (usually springsettings.cfg).
This setting is not supported by spring-dedicated, it is only usefull when using SPADS with spring-headless.
-
<null>: no configuration file is needed (spring-dedicated case), or default configuration file is used (spring-headless case)
Absolute path to a correct Spring configuration file: configuration file used by spring-headless
-
<null>
[global:springServer]
Spring server path
-
Absolute path of the Spring server binary file. This setting must only be defined when a custom Spring installation is used with SPADS, i.e. when Spring version auto-management is disabled (cf [global:autoManagedSpringVersion]).
-
<null>
Any executable file absolute path
-
%springServer% (set during installation, examples: "/var/home/spring/bin/spring-dedicated", "C:\Program files\Spads\spring-headless.exe")
[global:springServerType]
Spring server type
-
Type of Spring server binary used with SPADS.
This setting must be defined if Spring version auto-management is enabled (cf [global:autoManagedSpringVersion]).
-
<null>: the server type is auto-detected from spring server binary name (see [global:springServer])
dedicated
headless
-
%springServerType% (set during installation, example: "dedicated")
[global:unitsyncDir]
Unitsync library directory
-
Absolute path of the unitsync library directory. This setting must only be defined when a custom Spring installation is used with SPADS, i.e. when Spring version auto-management is disabled (cf [global:autoManagedSpringVersion]).
-
<null>
Any readable directory containing a unitsync library (absolute path)
-
%unitsyncDir% (set during installation, examples: "/usr/local/lib", "C:\Program files\Spring")
[global:springDataDir]
Spring data directories
-
Absolute pathes of the directories containing Spring base files, games or maps.
Directories must be separated by colons (":") on Linux, and by semicolons (";") on Windows.
When Spring version auto-management is enabled (cf [global:autoManagedSpringVersion]), Spring base files are automatically loaded, so only Spring data directories containing games or mods need to be declared here in this case.
-
Any readable directories (absolute pathes)
-
%dataDir% (set during installation, examples: "/share/games/spring", "C:\Program files\Spring")
[global:autoReloadArchivesMinDelay]
Minimum delay before auto-reloading Spring archives
-
SPADS can auto-detect changes in Spring archives, and auto-reload them if needed.
If the autoReloadArchivesMinDelay is set to 0, then this feature is disabled, else it is enabled.
When this feature is enabled, the autoReloadArchivesMinDelay contains the minimum delay in seconds to wait since the last change in Spring archives before reloading them automatically (this is useful to avoid reloading incomplete archives that are still being uploaded for instance).
-
Integer
-
30
[global:sequentialUnitsync]
Sequential unitsync mode
-
Specifies if SPADS must use the unitsync library in sequential mode instead of parallel mode. When using sequential mode, all the SPADS instances with same [global:varDir] will synchronize themselves so that only one instance is calling the unitsync library at a time.
-
0: disabled
1: enabled
-
0
[global:autoLearnMaps]
Automatic map learning
-
Specifies if SPADS must learn automatically all the maps hosted by the other hosts, so that it can host them in ghost-map mode later (without having them locally on the server)
-
0: disabled
1: enabled
-
0
[global:sendRecordPeriod]
Send record period for output flood protection
-
Period in seconds during which data sent to lobby server is measured to avoid flooding it (see also [global:maxBytesSent] and [global:maxLowPrioBytesSent]).
A value of '0' disables output flood protection.
-
Integer
-
10
[global:maxBytesSent]
Max bytes sent to lobby server
-
Amount of bytes that can be sent to lobby server during send record period (see also [global:sendRecordPeriod]).
Output flood protection is performed by queueing excessive data.
-
Integer
-
19000
[global:maxLowPrioBytesSent]
Max low-priority bytes sent to lobby server
-
Amount of low-priority bytes (private messages, command responses...) that can be sent to lobby server during send record period (see also [global:sendRecordPeriod]).
Output flood protection is performed by queueing excessive data in a specific low-priority queue.
-
Any integer smaller than the [global:maxBytesSent] value
-
18000
[global:maxChatMessageLength]
Maximum lobby chat message length
-
Whenever SPADS needs to send a chat message to lobby server, it will first split the message if needed so that each message will have a maximum length of <maxChatMessageLength> bytes.
-
Integer
-
1024
[global:maxAutoHostMsgLength]
Maximum AutoHost message length
-
Whenever SPADS needs to send a message on the AutoHost interface, it will first split the message if needed so that each message will have a maximum length of <maxAutoHostMsgLength> bytes.
-
Integer
-
240
[global:promoteDelay]
Promote delay
-
Minimum delay in seconds between two promote messages (see also [global:promoteChannels])
-
Integer
-
600
[global:msgFloodAutoKick]
Message flood auto-kick thresholds
-
Specifies the record period and the maximum number of chat messages triggered by a user during this period in the battle lobby before auto-kick for flood protection
-
<nbMsg>;<delay>
where <nbMsg> is the maximum number of chat messages before kick (integer)
<delay> is the record period in seconds (integer)
-
7;7
[global:statusFloodAutoKick]
Status flood auto-kick thresholds
-
Specifies the record period and the maximum number of status changes triggered by a user during this period in the battle lobby before auto-kick for flood protection
-
<nbMsg>;<delay>
where <nbMsg> is the maximum number of status changes before kick (integer)
<delay> is the record period in seconds (integer)
-
8;8
[global:kickFloodAutoBan]
Kick flood auto-ban thresholds
-
Specifies the record period, the maximum number of times someone can be auto-kicked during this period before being auto-banned, and the duration of this automatic ban for battle lobby flood protection
-
<nbAutoKick>;<delay>;<banDuration>
where <nbAutoKick> is the maximum number of times someone can be auto-kicked before ban (integer)
<delay> is the record period in seconds (integer)
<banDuration> is the duration in minutes of the automatic ban for auto-kick floods (integer)
-
2;120;5
[global:cmdFloodAutoIgnore]
Command flood auto-ignore thresholds
-
Specifies the record period, the maximum number of commands someone can send to the AutoHost during this period before being auto-ignored, and the duration of this automatic ignore for command flood protection
-
<nbCmd>;<delay>;<ignoreDuration>
where <nbCmd> is the maximum number of commands someone can send to the AutoHost before ignore (integer)
<delay> is the record period in seconds (integer)
<ignoreDuration> is the duration in minutes of the automatic ignore for command flood (integer)
-
4;4;2
[global:reCallVoteDelay]
Re-call vote delay
-
When a vote ends, SPADS prevents the user who started the vote to call another vote too fast, so that other users have some time to call a vote if they want to (vote flood protection). This is the minimum delay in seconds before someone can call another vote when his previous vote ended.
-
Integer
-
10
[global:floodImmuneLevel]
Flood immune level
-
When a user has an AutoHost access level superior or equal to this value, he is immune to flood protections.
-
Integer
-
100
[global:maxSpecsImmuneLevel]
Spectator limit immune level
-
When a user has an AutoHost access level superior or equal to this value, he is immune to maximum number of spectators limit (refer to [set:maxSpecs]).
-
Integer
-
100
[global:lobbyInterfaceLogLevel]
Lobby interface log level
-
Log level of the lobby interface module
-
0: critical
1: errors
2: warnings
3: notices
4: information
5: debug (all messages sent and received on the interface are logged!)
-
4
[global:autoHostInterfaceLogLevel]
AutoHost interface log level
-
Log level of the AutoHost interface module
-
0: critical
1: errors
2: warnings
3: notices
4: information
5: debug (all messages sent and received on the interface are logged!)
-
4
[global:updaterLogLevel]
Updater log level
-
Log level of the Updater module
-
0: critical
1: errors
2: warnings
3: notices
4: information
5: debug
-
4
[global:spadsLogLevel]
SPADS main log level
-
Log level of the core SPADS component
-
0: critical
1: errors
2: warnings
3: notices
4: information
5: debug
-
4
[global:simpleEventLogLevel]
SimpleEvent log level
-
Log level of the SimpleEvent module
-
0: critical
1: errors
2: warnings
3: notices
4: information
5: debug
-
4
[global:logChanChat]
Log channel chat
-
Specifies if channel chat must be logged
-
0: disabled
1: enabled
-
0
[global:logChanJoinLeave]
Log channel join/leave
-
Specifies if channel join/leave messages must be logged
-
0: disabled
1: enabled
-
0
[global:logBattleChat]
Log battle lobby chat
-
Specifies if battle lobby chat must be logged
-
0: disabled
1: enabled
-
1
[global:logBattleJoinLeave]
Log battle lobby join/leave
-
Specifies if battle lobby join/leave messages must be logged
-
0: disabled
1: enabled
-
1
[global:logGameChat]
Log game chat
-
Specifies if game chat must be logged
-
0: disabled
1: enabled
-
1
[global:logGameJoinLeave]
Log game join/leave
-
Specifies if game join/leave messages must be logged
-
0: disabled
1: enabled
-
1
[global:logGameServerMsg]
Log game server messages
-
Specifies if game server messages must be logged
-
0: disabled
1: enabled
-
1
[global:logPvChat]
Log private lobby messages
-
Specifies if private messages sent to the AutoHost must be logged
-
0: disabled
1: enabled
-
1
[global:alertLevel]
Alert level
-
Minimum AutoHost access level required to receive AutoHost alerts (do not set this too low or you will spam everyone !)
-
Integer
-
130
[global:alertDelay]
Alert delay
-
Delay in hours before re-sending alerts to a user
-
Integer
-
6
[global:alertDuration]
Alert duration
-
After this delay (in hours), alerts are automatically discared. This delay shouldn't be too low because an AutoHost admin could miss alerts if he doesn't connect to lobby server very often.
-
Integer
-
72
[global:masterChannel]
AutoHost master channel
-
If specified, the AutoHost will join this channel and listen to AutoHost commands in it. When running multiple AutoHosts, this can be useful to perform commands on severall AutoHosts at once.
-
<null> (functionality disabled)
Any valid lobby channel name
-
<null>
[global:opOnMasterChannel]
Operator on master channel
-
Specifies if the AutoHost has operator access on the master channel. If so, it will be able to kick players from channel (for banned players or !bKick command)
-
0: no
1: yes
-
0
[global:broadcastChannels]
List of broadcast channels
-
Contains the list of lobby channels in which basic battle status messages are broadcasted.
-
<null> (functionality disabled)
<channel1>[ <password1>][;<channel2>[ <password2>][;...]]
-
<null>
[global:promoteChannels]
List of promote channels
-
Contains the list of lobby channels in which messages to promote current battle will be sent when !promote command is used.
-
<null> (functionality disabled)
<channel1>[ <password1>][;<channel2>[ <password2>][;...]]
-
<null>
[global:promoteMsg]
Promote message
-
Message sent to promote channels when !promote command is used.
%u is replaced by the user performing !promote command
%p is replaced by the number of needed players for current expected battle structure (nbTeams x teamSize x nbPlayerById)
%b is replaced by the battle name
%o is replaced by the mod name
%a is replaced by the map name
%P is replaced by the number of players currently in battle
%S is replaced by the number of spectators currently in battle
%U is replaced by the number of users (players+spectators) currently in battle
-
<null> (functionality disabled)
Any string
-
%pplayer(s) needed for battle "%b" [%o, %a] (%u)
[global:defaultPreset]
Default preset
-
It is the default preset name.
Presets are defined as sections of spads.conf file. The default preset must be complete (i.e. it must define all preset settings)
-
Any complete preset defined in spads.conf
-
default
[global:restoreDefaultPresetDelay]
Default preset restore delay
-
Number of seconds before restoring the default preset when battle is empty. When set to 0, it disables the auto-restore default preset functionality.
-
Integer
-
30
[global:autoLockClients]
Number of clients for auto-lock
-
When this number of clients (players and spectators) is in the battle lobby, SPADS auto-locks the battle.
This is useful when you know your network connection cannot support more than x clients, should they be players or spectators.
This is different from [hSet:maxPlayers], which configures the hosting room capacity regarding number of players only.
This is also different from [set:autoLock], which configures auto-locking based on number of players only.
When set to 0, it disables the auto-lock on client count functionality.
-
Integer
-
64
[global:autoSaveBoxes]
Auto-save start boxes
-
If enabled, SPADS will automatically save the start boxes when a game is launched.
-
0: disabled
1: enabled
2: enabled only if there is no start box saved for this map yet
-
1
[global:botsRank]
Rank for bots
-
This setting defines the rank attibuted to AI bots when auto-balancing the battle.
-
0: Newbie
1: Beginner
2: Average
3: Above average
4: Experienced
5: Highly experienced
6: Veteran
-
3
[global:voteTime]
Vote time
-
When a vote is called, this is the delay in seconds during which clients are allowed to vote.
This global setting can also be overridden individually for each command in the commands rights configuration file (see [set:commandsFile]). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "minVoteParticipation" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,minVoteParticipation:75)".
-
Integer
-
45
[global:minVoteParticipation]
Minimum vote participation
-
This is the minimum percent of voters that must have voted manually for a poll to be taken into account by SPADS.
If two values are provided (separated by ";" character), then the first one is used when there is no game in progress and the second one is used when a game is in progress.
This global setting can also be overridden individually for each command in the commands rights configuration file (see [set:commandsFile]). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "minVoteParticipation" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,minVoteParticipation:75)".
-
<percent>: Integer between 0 and 100 included (a single value is used, no distinction is made whether a game is running or not)
<percent1>;<percent2>: Integers between 0 and 100 included (<percent1> is used when no game is running, <percent2> is used when a game is running)
-
50
[global:majorityVoteMargin]
Majority vote margin
-
Specifies the percentage of the casted votes required for the vote to pass, in addition to the 50% already required by default.
If set to zero, SPADS will use the standard majority vote system: the vote will pass if more than 50% of the casted votes are "yes".
If not set to zero, SPADS will require supermajority (aka "qualified majority"): the required percentage of the casted votes for the vote to pass will be 50% + the configured value. If set to 50 (maximum value), unanimity will be required for the vote to pass.
This global setting can also be overridden individually for each command in the commands rights configuration file (see [set:commandsFile]). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "majorityVoteMargin" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,majorityVoteMargin:25)".
-
Integer between 0 and 50 included
-
0
[global:awayVoteDelay]
Away vote delay
-
Configures the delay to wait before triggering automatic blank votes for players who are in away vote mode (see [pSet:voteMode]). The delay can be expressed as a number of seconds or a percentage of the vote time (see [global:voteTime]).
This global setting can also be overridden individually for each command in the commands rights configuration file (see [set:commandsFile]). The command-specific setting value must be declared at the end of the corresponding command declaration line, in parentheses. If multiple settings are overridden this way for a command, they must be separated by a comma. For example, to use specific values of "voteTime" and "awayVoteDelay" for the "stop" command, the command declaration line could be: "[stop](voteTime:60,awayVoteDelay:50%)".
-
<null>: the away vote mode is disabled
Integer: number of seconds to wait before triggering automatic blank votes
<percent>%: percentage of total vote time to wait before triggering automatic blank votes
-
20
[global:pluginsDir]
SPADS plugins directory
-
Location of SPADS plugins. This directory path can be an absolute path or a path relative to [global:varDir] directory.
-
Any readable directory
-
plugins
[global:autoLoadPlugins]
Auto-loaded plugins
-
Contains the names of the SPADS plugins that will be automatically loaded on start, separated by ';'
-
<null>: no plugin loaded autmatically
<pluginName>[;<pluginName2>[...]]: plugins <pluginName>, <pluginName2>[...] will be automatically loaded on start
-
<null>
[global:springieEmulation]
Springie emulation mode
-
Specifies the Springie emulation mode.
-
on: Springie commands are emulated
off: Springie commands are not emulated
warn: Springie commands are emulated, but a warning message is sent in private to the player when a deprecated command is used
-
off
[global:dataDumpDelay]
Data dump delay
-
User preferences and map hashes are stored periodicly into preferences.dat and mapHashes.dat files. This setting defines the delay in minutes between such dumps.
If set to 0, the functionality is disabled (dynamic data are then dumped only when SPADS exits normally)
-
Integer
-
60
[global:allowSettingsShortcut]
Allow settings shortcut
-
If enabled, SPADS will allow clients to use following shortuct commands:
Instead of "!list <dataType>", it is possible to type directly "!<dataType>".
Instead of "!set <settingName> <value>", it is possible to type directly "!<settingName> <value>" (same for "hSet", "bSet" ...).
Instead of "!help set <settingName>", it is possible to type directly "!help <settingName>" (same for "hSet", "bSet" ...).
-
0: disabled
1: enabled
-
1
[global:kickBanDuration]
Ban duration for kickBan command
-
Duration of the ban applied when using !kickBan command (expressed in seconds, or in number of games if the value is suffixed with 'g')
-
<nbOfSeconds>: <nbOfSeconds> is the ban duration expressed in seconds
<nbOfGames>g: <nbOfGames> is the ban duration expressed in number of games
-
300
[global:privacyTrustLevel]
Privacy trust level
-
Specifies the minimum access level required to see personal information about players (IP addresses, non-rounded skill values...) in the output of some commands (!list bans, !searchUser, !smurfs, !status and !whois).
-
Integer
-
130
[global:userDataRetention]
User data retention
-
SPADS can store user data (IP addresses, ranks ...) so that IP bans and anti-smurf are possible.
The "userDataRetention" global setting contains the number of days during which user data are kept even if the user hasn't been seen online, followed by the maximum number of IPs (useful to deal with dynamic IPs) and the maximum number of names (useful to track renames) that can be bound to an account, separated by ";".
-
<retentionPeriod>;<maxIPs>;<maxNames>
where <retentionPeriod> is the delay in days during which user data are stored ("-1" => data are kept forever, "0" => user data retention disabled)
<maxIPs> is the maximum number of IPs bound to an account ("-1" => all IPs are kept, "0" => IPs aren't stored)
<maxNames> is the maximum number of names bound to an account ("-1" => all names are kept, "0" => only one name is stored by account, "1" => max 2 names ...)
-
0;0;0
[global:useWin32Process]
Use Win32 process
-
Specifies if SPADS must use the native process spawning method to launch Spring server on Windows (using Win32 process instead of Perl fork emulation)
-
0: Perl fork implementation is used to spawn Spring server process
1: Win32 process is used to spawn Spring server process (allowed on Windows platform only)
-
0
[global:eventModel]
Event model
-
The "eventModel" global setting specifies which event model must be used by SPADS. SPADS is based on the asynchronous programming paradigm, with events, event handlers, callbacks etc. It can use either its own internal event model, or the Perl AnyEvent module if available on the system.
Compared to the internal event model, AnyEvent is more efficient and makes it possible to integrate a lot of high-performance Perl modules such as web servers directly in the plugins.
The default time slice used for the event loop is 0.5 second. This can be changed by specifying the desired value between parentheses after the event model type (unit is hundredth of second, default value is 50).
-
<eventModelType>
<eventModelType>(<timeSlice>)
Examples:
"auto": AnyEvent is used if available, otherwise the internal event model is used
"internal": internal event model is used
"AnyEvent": AnyEvent is used
"internal(20)": internal event model is used, with an event loop time slice of 0.2 second instead of default 0.5 second
-
auto
[global:maxChildProcesses]
Maximum number of child processes
-
Specifies how many child processes can be spawned by SPADS simultaneously (other processes are queued).
-
Integer
-
16
###############################################################################
# Preset settings (defined in sections of spads.conf file) #
###############################################################################
[set:description]
Preset description
-
Preset description that appears in "!list presets" output.
This is a special preset setting: it cannot be changed by using !set command.
-
Any String
-
Default SPADS settings
[set:rotationType]
Rotation type
-
SPADS automatic rotation system can occur at the end of each game and/or when the battle is empty (refer to [set:rotationEndGame] and [set:rotationEmpty]).
The "rotationType" preset setting specifies whether map rotation or preset rotation is selected.
When map rotation is selected, a new map is chosen automatically in current map list. A subset of current map list can be specified for map rotation (refer to syntax below)
When preset rotation is selected, a new preset available from current preset is chosen automatically (refer to [set:preset])
-
map: map rotation is selected (any map of current map list can be chosen as next map)
preset: preset rotation is selected (any preset available form current preset can be chosen as next preset)
map;<subMapList>: map rotation with sub map list filter is selected (any map belonging to both current map list and <subMapList> can be chosen as next map)
-
map