Merge 2a8f85c into 2e42723

doc/configuration.rst

@@ -80,4 +80,3 @@ Options
 
 .. toctree::
     config-options
-    script-options

doc/included-scripts.rst

@@ -156,6 +156,11 @@ piqueserver\.scripts\.ratio script
 
 .. automodule:: piqueserver.scripts.ratio
 
+piqueserver\.scripts\.analyze script
+++++++++++++++++++++++++++++++++++++
+
+.. automodule:: piqueserver.scripts.analyze
+
 piqueserver\.scripts\.rollback script
 +++++++++++++++++++++++++++++++++++++
 

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

piqueserver/scripts/aimbot2.py

@@ -1,7 +1,21 @@
 """
-Plugin to detect and react to possible aimbot users
+Detects and reacts to possible aimbot users.
 
-maintained by: ?
+Commands
+^^^^^^^^
+
+* ``/accuracy <player>`` shows player's accuracy per weapon
+* ``/hackinfo <player>`` shows player's accuracy, K/D ratio and how often their cross-hair snaps onto another players head *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

piqueserver/scripts/airstrike2.py

@@ -1,7 +1,13 @@
 """
 Airstrikes. Boom!
 
-Maintainer: hompy
+Commands
+^^^^^^^^
+
+* ``/airstrike or /a`` allows a player to call an airstike
+* ``/givestrike <player>`` gives a player the ability to call an airstike immediately *admin only*
+
+.. codeauthor:: hompy
 """
 
 from math import ceil, sin, cos

piqueserver/scripts/analyze.py

@@ -4,11 +4,9 @@
 Commands
 ^^^^^^^^
 
-* ``/analyze or /an <target>`` to show a detailed analysis of a players shots if they hit somone.
-|	hit player, distance, dT in miliseconds (Delta Time- Time since previous shot that
-|	hit someone.  Useful for detecting multiple bullet or rapid hacks), weapon, what
-|	body part it hit, and a basic counter that displays the number of hits
-|	of that type.
+* ``/analyze or /an <target>`` to show a detailed analysis of a players shots if they hit someone. 
+  Shows hit player, distance, dT in miliseconds (Delta Time- Time since previous shot that hit someone. 
+  Useful for detecting multiple bullet or rapid hacks), weapon, which body part it hit, and a basic counter that displays the number of hits of that type.
 
 * ``/analyze or /an`` to disable it
 

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

piqueserver/scripts/autohelp.py

@@ -1,7 +1,7 @@
 """
 Helps Deuces automagically when they ask in the chat for help.
 
-Maintainer: ?
+.. codeauthor:: ?
 """
 
 import re

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 griefers
+* Banning aimbotters
+* Banning racists
+
+Since it is automatic it won't always get it right.
+
+Commands
+^^^^^^^^
+
+* ``/badmin`` shows which badmin options are enabled/disabled *admin only*
+* ``/investigate <player>`` shows a player's grief score, K/D ratio and hit accuracy *admin only*
+
+.. note::
+  It depends on the 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

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 <player> <minutes>`` 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

piqueserver/scripts/daycycle.py

@@ -1,7 +1,15 @@
 """
 Gives Ace of Spades a daycycle (using the fog).
 
-Maintainer: hompy
+Commands
+^^^^^^^^
+
+* ``/dayspeed <speed>`` sets day speed *admin only*
+* ``/dayspeed`` gets day speed *admin only*
+* ``/daytime <time>`` sets day time *admin only*
+* ``/daytime`` gets day time
+
+.. codeauthor:: hompy
 """
 
 from math import modf

piqueserver/scripts/demolitionman.py

@@ -1,9 +1,12 @@
 """
-Demolition man script.
-Copyright (c) 2013 learn_more
-See the file license.txt or http://opensource.org/licenses/MIT for copying permission.
-
 Restocks the user when reloading / throwing a nade.
+
+Commands
+^^^^^^^^
+
+* ``/toggledemo`` toggles demolition
+
+.. codeauthor:: learn_more (MIT LICENSE)
 """
 
 from piqueserver.commands import command, admin

piqueserver/scripts/dirtnade.py

@@ -1,7 +1,7 @@
 """
 Makes grenades create blocks.
 
-Maintainer: hompy
+.. codeauthor:: hompy
 """
 
 from pyspades.contained import BlockAction

piqueserver/scripts/disco.py

@@ -1,7 +1,12 @@
 """
 Ever wanted a disco in Ace of Spades?
 
-Maintainer: mat^2
+Commands
+^^^^^^^^
+
+* ``/disco`` toggles disco
+
+.. codeauthor:: mat^2
 """
 
 from twisted.internet.task import LoopingCall

piqueserver/scripts/flagreturn.py

@@ -1,8 +1,7 @@
 """
 Makes the flag returnable in Quake-like fashion.
 
-Maintainer: mat^2
-fixed by learn_more
+.. codeauthor:: mat^2 & learn_more
 """
 
 from pyspades.collision import vector_collision

piqueserver/scripts/geoip.py

@@ -1,3 +1,16 @@
+"""
+Gets a player's location info using a geoip database.
+
+.. note::
+  This script depends on `pygeoip` package and `piqueserver --update-geoip` needs to be executed after installing the package.
+
+Commands
+^^^^^^^^
+* ``/from <player>`` get player's location info
+
+.. codeauthor:: ?
+"""
+
 import os
 from piqueserver.commands import command, get_player
 from piqueserver.config import config

piqueserver/scripts/map_extensions.py

@@ -1,7 +1,7 @@
 """
-Extensions to the map metadata (e.g. water damage).
+Provides extensions to the map metadata (e.g. water damage).
 
-Maintainer: ?
+.. codeauthor:: ?
 """