search

Yaribz / SPADS

SpringRTS Perl Autohost for Dedicated Server
GNU General Public License v3.0
17 stars 16 forks source link

Document commands.conf #64

Open Beherith opened 1 year ago

Beherith commented 1 year ago

Please check if these are actually correct :)

Yaribz commented 1 year ago

Thank you for your pull request !

Actually several SPADS config files share the same syntax, based on a list of usable input fields (filters), dynamic customizable templates (lines starting with #?), and a first match logic (these files are users.conf, levels.conf, bans.dat, banLists.conf and commands.conf).

I would like to avoid repeating the same info in each file (for example the fact that commas can be used as logic OR in input fields, the fact that lines starting with #? are templates (re)definitions...). What I wanted to do initially was writing all these info in an operating guide and refer to it in the config files header. The config file headers would then only contain their specific characteristics (input fields names etc.). Unfortunately I never took the time required to write this guide so this documentation is lacking, but in my opinion this general info regarding SPADS config files really belongs in a document like that to avoid duplication of information...

However, following this logic, what is clearly missing in the commands.conf file is the list of allowed sections attributes, which can be used to override global SPADS settings for specific commands. You listed voteTime and majorityVoteMargin in your PR but there are two more: awayVoteDelay and minVoteParticipation. I will update the header to add this information, thanks again!