diff --git a/piqueserver/scripts/afk.py b/piqueserver/scripts/afk.py index 100ef5ac6..5444987b0 100644 --- a/piqueserver/scripts/afk.py +++ b/piqueserver/scripts/afk.py @@ -1,7 +1,15 @@ """ Kicks a player if inactive for too long. -Maintainer: hompy +Options +^^^^^^^ + +.. code-block:: guess + + [afk] + time_limit = 15 # in minutes + +.. codeauthor:: hompy """ from operator import attrgetter diff --git a/piqueserver/scripts/aimbot2.py b/piqueserver/scripts/aimbot2.py index 1ee901a2f..44cf49c19 100644 --- a/piqueserver/scripts/aimbot2.py +++ b/piqueserver/scripts/aimbot2.py @@ -1,7 +1,21 @@ """ -Plugin to detect and react to possible aimbot users +Detects and react to possible aimbot users. -maintained by: ? +Commands +^^^^^^^^ + +* ``/accuracy `` shows player's accuracy per weapon +* ``/hackinfo `` shows player's accuracy, K/D ratio and snaps *admin only* + +Options +^^^^^^^ + +.. code-block:: guess + + [aimbot] + collect_data = true # saves hits and shots of each weapon to a csv file + +.. codeauthor:: ? """ import os import csv diff --git a/piqueserver/scripts/airstrike2.py b/piqueserver/scripts/airstrike2.py index 41ae14e15..9f8eed80c 100644 --- a/piqueserver/scripts/airstrike2.py +++ b/piqueserver/scripts/airstrike2.py @@ -1,7 +1,13 @@ """ Airstrikes. Boom! -Maintainer: hompy +Commands +^^^^^^^^ + +* ``/airstrike or /a`` allows a player to call an airstike +* ``/givestrike `` gives a player the ability to call an airstike immediately *admin only* + +.. codeauthor:: hompy """ from math import ceil, sin, cos diff --git a/piqueserver/scripts/antijerk.py b/piqueserver/scripts/antijerk.py index fd3db1cb6..2e33f86f4 100644 --- a/piqueserver/scripts/antijerk.py +++ b/piqueserver/scripts/antijerk.py @@ -1,7 +1,15 @@ """ Kicks jerks for 'PRESS ALT-F4 FOR AIRSTRIKES' and so on. -Maintainer: ? +Options +^^^^^^^ + +.. code-block:: guess + + [antijerk] + ban_duration = 15 # in minutes + +.. codeauthor:: ? """ import re diff --git a/piqueserver/scripts/autohelp.py b/piqueserver/scripts/autohelp.py index 0156b9f04..4c4401861 100644 --- a/piqueserver/scripts/autohelp.py +++ b/piqueserver/scripts/autohelp.py @@ -1,7 +1,7 @@ """ Helps Deuces automagically when they ask in the chat for help. -Maintainer: ? +.. codeauthor:: ? """ import re diff --git a/piqueserver/scripts/badmin.py b/piqueserver/scripts/badmin.py index 1ed5de32f..5a1c04b4c 100644 --- a/piqueserver/scripts/badmin.py +++ b/piqueserver/scripts/badmin.py @@ -1,6 +1,25 @@ -# Badmin is an bot admin. He'll do a variety of common admin tasks so you don't have to. -# He might not always get it right, but he'll get it done, and isn't that what really matters? -# -Requirements: blockinfo.py (for grief detection), ratio.py (for k/d ratio), aimbot2.py (hit accuracy) +""" +Badmin is an bot admin. + +It automates common admin tasks such as: + +* Banning greifers +* Banning aimbots +* Banning racists + +Since it is automate it won't always get it right. + +Commands +^^^^^^^^ + +* ``/badmin`` shows which badmin options are enabled/disabled *admin only* +* ``/investigate `` shows a player's grief score, K/D ratio and hit accuracy *admin only* + +.. note:: + It is dependant on blockinfo.py (for grief detection), ratio.py (for k/d ratio), aimbot2.py (hit accuracy) scripts. + +.. codeauthor:: ? +""" from twisted.internet import reactor from pyspades.common import prettify_timespan @@ -9,6 +28,7 @@ from piqueserver.commands import command, admin, get_player import re +# TODO: convert settings to config options BADMIN_VERSION = 9 # Settings for auto-aimbot SCORE_AIMBOT_ENABLED = True diff --git a/piqueserver/scripts/blockinfo.py b/piqueserver/scripts/blockinfo.py index 6f223966c..4f128c37a 100644 --- a/piqueserver/scripts/blockinfo.py +++ b/piqueserver/scripts/blockinfo.py @@ -1,9 +1,24 @@ """ A tool for identifying griefers. -Maintainer: hompy +.. note:: + "blockinfo" must be AFTER "votekick" in the config script list -Note: "blockinfo" must be AFTER "votekick" in the config.txt script list +Commands +^^^^^^^^ + +* ``/griefcheck or /gc `` gives you when, how many and whos blocks a player destroyed *admin only* + +Options +^^^^^^^ + +.. code-block:: guess + + [blockinfo] + griefcheck_on_votekick = true + irc_only = false + +.. codeauthor:: hompy """ from twisted.internet.reactor import seconds diff --git a/piqueserver/scripts/daycycle.py b/piqueserver/scripts/daycycle.py index 8164a21e4..c1b150c0f 100644 --- a/piqueserver/scripts/daycycle.py +++ b/piqueserver/scripts/daycycle.py @@ -1,7 +1,15 @@ """ Gives Ace of Spades a daycycle (using the fog). -Maintainer: hompy +Commands +^^^^^^^^ + +* ``/dayspeed `` sets day speed *admin only* +* ``/dayspeed`` gets day speed *admin only* +* ``/daytime