SPADS

SPADS (Spring Perl Autohost for Dedicated Server) is a Perl autohost program for SpringRTS, released under GPL v3 license. It has been designed from start for headless servers without any graphic interface, and is heavily customizable through various configuration levels and a plugin system. For more details please refer to SPADS thread on Spring forums.

Components

• src/spads.pl: SPADS application.
• src/SpadsConf.pm: Perl module handling SPADS configuration and dynamic data files.
• src/spadsInstaller.pl: SPADS installation script.
• src/SpadsUpdater.pm: Perl module handling SPADS automatic update.
• src/update.pl: Application to update SPADS components manually.
• src/SpadsPluginApi.pm: Perl module implementing the plugin API for SPADS.
• src/getDefaultModOptions.pl: Application to retrieve the list of modoptions for all installed mods, and convert them optionnaly in SPADS format to copy-paste in the battlePresets.conf configuration file.
• src/PerlUnitSync.pm: Perl module implementing the unitsync library interface.
• SPADS configuration templates: Templates for SPADS configuration files.
• var/help.dat: Data file for SPADS commands help.
• var/helpSettings.dat: Data file for SPADS settings help.
• SPADS reference guide: HTML documentation of all SPADS commands and settings (generated from help data files).
• SPADS plugin API: HTML documentation of the SPADS plugin API (generated from SPADS plugin API module).
• Official SPADS plugins: Official SPADS plugins sources.
• SPADS plugins templates: Templates for SPADS plugins development.
• SPADS plugins tutorials: Sources of the SPADS plugins used in the tutorials.
• packages.txt: SPADS packages index file for HTTP repository (used for automatic updates).
• UPDATE.md: Manual update procedure for major SPADS versions.

SPADS is based on the templates provided by following project:

• SpringLobbyBot

Dependencies

The SPADS application depends on following projects:

• SimpleLog
• SimpleEvent
• SpringLobbyInterface
• SpringAutoHostInterface
• Spring

SPADS also depends on following projects (hosted remotely) for additional functionalities:

• SLDB for TrueSkill support and advanced multi-account detection.
• spring replay site for automatic replay uploading.

Installation

The installation can be performed by following the instructions of the INSTALL.md file.

The installation package contains following components (other components are automatically downloaded):

• INSTALL.md
• LICENSE
• SimpleLog.pm
• spadsInstaller.pl
• SpadsUpdater.pm

Documentation

• The SPADS reference guide for all SPADS commands and settings is available online here. It can be generated from any SPADS installation directory by using following command (files are generated in the directory specified by the "varDir" setting in spads.conf):

    perl spads.pl etc/spads.conf --doc
  

• The SPADS plugin API documentation is available online here. It can be generated from any SPADS installation directory by using following command (the pod2html.css file can be found here):

    pod2html -css=pod2html.css --infile=SpadsPluginApi.pm --outfile=spadsPluginApiDoc.html --title="SPADS Plugin API Doc"
  

• Additional documentation can be found on SPADS wiki.

Licensing

Please see the file called LICENSE.

Author

Yann Riou [email protected]