Merge 604ee00 into d91c097

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,15 @@
 """
-Plugin to detect and react to possible aimbot users
+Detects and react to possible aimbot users.
 
-maintained by: ?
+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``
+* ``/givestrike <player>``
+
+.. codeauthor:: hompy
 """
 
 from math import ceil, sin, cos

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,19 @@
-# 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.
+
+.. 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

piqueserver/scripts/blockinfo.py

@@ -1,9 +1,19 @@
 """
 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
+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,13 @@
 """
 Gives Ace of Spades a daycycle (using the fog).
 
-Maintainer: hompy
+Commands
+^^^^^^^^
+
+* ``/dayspeed``
+* ``/daytime``
+
+.. 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``
+
+.. 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``
+
+.. 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 is dependant on `pygeoip` package and `piqueserver --update-geoip` needs to be executed after installing the package.
+
+Commands
+^^^^^^^^
+* ``/from <player>``
+
+.. 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:: ?
 """
 
 

piqueserver/scripts/markers.py

@@ -22,7 +22,13 @@
 Any functionality can be disabled switching off SHADOW_INTEL, REVEAL_ENEMIES,
 VV_ENABLED and CHAT_MARKERS below.
 
-Maintainer: hompy
+Commands
+^^^^^^^^
+* ``/clear``
+* ``/togglemarkers``
+* ``/markers``
+
+.. codeauthor:: hompy
 """
 
 import csv

piqueserver/scripts/match.py

@@ -2,7 +2,16 @@
 Match script, useful for public matches. Features verbose announcements
 on IRC and a custom timer.
 
-Maintainer: mat^2
+Commands
+^^^^^^^^
+
+* ``/timer``
+* ``/stoptimer``
+* ``/startrecord``
+* ``/stoprecord``
+* ``/saverecord``
+
+.. codeauthor: mat^2
 """
 import os
 

piqueserver/scripts/medkit.py

@@ -1,8 +1,21 @@
 """
 Gives a specified amount of medkits on spawn
 
-Author: Booboorocks998
-Maintainer: mat^2
+Commands
+^^^^^^^^
+
+* ``/medkit or /m``
+
+Options
+^^^^^^^
+
+.. code-block:: guess
+
+   [medkit]
+   medkits = 1 # no. of medkits
+   medkit_heal_amount = 40 # how much hp. it gives
+
+.. codeauthor:: Booboorocks998 & mat^2
 """
 
 from piqueserver.commands import command

piqueserver/scripts/memcheck.py

@@ -2,7 +2,7 @@
 Runs the garbage collector at a given interval and displays any uncollected
 garbage found.
 
-Maintainer: mat^2
+.. codeauthor:: mat^2
 """
 
 from twisted.internet import reactor

piqueserver/scripts/minefield.py

@@ -1,13 +1,13 @@
 """
 Minefield map extension.
-Copyright (c) 2013 learn_more
-See the file license.txt or http://opensource.org/licenses/MIT for copying
-permission.
 
 Allows mappers to specify the map bounds, outside of which players will trip
 mines.  Breaking blocks (when standing close to the field) also triggers a
 mine.
 
+.. note::
+   This script conflicts with `smartnade` script.
+
 example extension from mapname.txt:
 
 >>> extensions = {
@@ -30,10 +30,7 @@
 ...     ]
 ... }
 
-Support thread: http://buildandshoot.com/viewtopic.php?f=19&t=8089
-Script location: https://github.com/learn-more/pysnip/blob/master/scripts/minefield.py
-
-Warning: conflicts with `smartnade` script.
+.. codeauthor:: learn_more (MIT LICENSE)
 """
 # todo: reset intel in minefield
 

piqueserver/scripts/nointelonwalls.py

@@ -1,8 +1,9 @@
 """
-nointelonwalls.py - prevents taking intel through walls
-by kmsi(kmsiapps@gmail.com)
-inspired by nospadingwalls.py & omgnograbbingthroughwallsanymore.py
+Prevents taking intel through walls
+
 Version 2(2017.12.25)
+
+.. codeauthor:: kmsi<kmsiapps@gmail.com>
 """
 
 

piqueserver/scripts/paint.py

@@ -1,11 +1,14 @@
 """
 Lets you change the color of the block you are looking at.
-/paint [player] enables painting mode for the player.
-
 With block tool selected, pick a color, then hold down sneak key
 (<V> by default) to paint.
 
-Maintainer: hompy
+Commands
+^^^^^^^^
+
+* ``/paint <player>`` enables painting mode for that player.
+
+.. codeauthor:: hompy
 """
 
 from pyspades.contained import BlockAction

piqueserver/scripts/passreload.py

@@ -1,5 +1,13 @@
-# passreload.py
-# written by Danke
+"""
+Allows reloading config on the fly
+
+Commands
+^^^^^^^^
+
+* ``/reloadconfig``
+
+.. codeauthor:: Danke
+"""
 
 import json
 import os.path

piqueserver/scripts/protect.py

@@ -1,7 +1,7 @@
 """
 Protects areas against block destroying/building.
 
-Maintainer: hompy
+.. codeauthor:: hompy
 """
 
 from piqueserver.commands import command, admin

piqueserver/scripts/rampage.py

@@ -8,7 +8,7 @@
 
 Intended for use in frantic last team standing or free for all matches.
 
-Maintainer: hompy
+.. codeauthor:: hompy
 """
 
 from collections import deque

piqueserver/scripts/rangedamage.py

@@ -1,7 +1,24 @@
 """
 Changes the damage values depending on distance.
 
-Maintainer: ?
+Options
+^^^^^^^
+
+.. code-block:: guess
+
+   [rangedamange.rifle]
+   pct_per_block = 0 # percentage per block?
+   multiplier = 1
+
+   [rangedamange.smg]
+   pct_per_block = 0
+   multiplier = 1
+
+   [rangedamange.shotgun]
+   pct_per_block = 0
+   multiplier = 1
+
+.. codeauthor:: ?
 """
 
 from pyspades.constants import (SHOTGUN_WEAPON, SMG_WEAPON, RIFLE_WEAPON)