Improve docs #nobuild

dave/xdcc
dave 7 years ago
parent c89600433d
commit e55a7472ba
  1. 19
      docs/api/modules/calc.rst
  2. 24
      docs/api/modules/cardsagainsthumanity.rst
  3. 56
      docs/api/modules/cryptowallet.rst
  4. 32
      docs/api/modules/dogedice.rst
  5. 37
      docs/api/modules/dogewallet.rst
  6. 9
      docs/api/modules/inventory.rst
  7. 14
      docs/api/modules/linktitler.rst
  8. 5
      docs/api/modules/randquote.rst
  9. 15
      docs/api/modules/remind.rst
  10. 6
      docs/api/modules/seen.rst
  11. 11
      docs/api/modules/tell.rst
  12. 4
      docs/api/modules/urban.rst
  13. 27
      docs/api/modules/weather.rst
  14. 8
      docs/api/modules/youtube.rst
  15. 1
      pyircbot/modules/DogeDice.py

@ -4,10 +4,21 @@
Commands
--------
- *calc* - returns a random fact
- *calc something = some definition* - add a fact
- *calc something =* - delete a fact
- *match keyword* - search facts
.. cmdoption:: calc
Returns a random fact
.. cmdoption:: calc <something> = <some definition>
Add a fact
.. cmdoption:: calc <something> =
Delete a fact
.. cmdoption:: match <keyword>
Search facts
Class Reference
---------------

@ -1,6 +1,30 @@
:mod:`CardsAgainstHumanity` --- CaH in IRC
==========================================
IRC based Cards Against Humanity clone. Requires "black card" messages to be
placed in file named ``questions.txt`` in the data dir, and "white card" messages
in a file named ``answers.txt``.
Commands
--------
.. cmdoption:: .joinGame
If the game hasn't started yet, join the lobby
.. cmdoption:: .ready
The game will start when all players are ready; this indicates a player is
ready
.. cmdoption:: .pick <card number> [<card number>] ...
If the player is not the card czar, play one or more cards from their hand
.. cmdoption:: .choose <card number>
If a player is the card czar, choose the winning card number
Class Reference
---------------

@ -3,6 +3,62 @@
Module to provide a multi-type cryptocurrency wallet
Config
------
.. code-block:: json
{
"types": {
"BTC": {
"name": "Bitcoin",
"abbr": "BTC",
"host": "192.168.1.210",
"username": "bobby",
"password": "propane",
"port": 8332,
"precision": 8,
"reserve": 0.0005,
"link": "https://bitcoin.org/"
}
}
}
.. cmdoption:: types
Dictionary of supported crypto currencies, keyed abbreviation => detail. All fields required.
.. cmdoption:: types.TYPE.precision
Number of decimal places the currency supports
.. cmdoption:: types.TYPE.reserve:
Minimum balance; this is to cover tx fees
Commands
--------
.. cmdoption:: .curinfo [<currency>]
See list of supported currencies, or info about a specific one.
.. cmdoption:: .getbal <currency>
Get current user's balance of a specific currency
.. cmdoption:: .setaddr <currency> <address>
Set current user's withdrawal address for <currency> to <address>
.. cmdoption:: .withdraw <currency> <amount>
Request a withdrawal of <amount> to current user's withdraw address of <currency>
.. cmdoption:: .getaddr <currency>
Get deposit address for <currency>
Class Reference
---------------

@ -3,6 +3,38 @@
Module to provide a game for gambling Dogecoin
.. code-block:: json
{
"minBet": 0.01,
"lobbyIdleSeconds": 15,
"channelWhitelistOn": true,
"channelWhitelist": [
"dogegamestest",
"test"
]
}
.. cmdoption:: lobbyIdleSeconds
When more than 1 player has joined, the game will start after this many
seconds
Commands
--------
.. cmdoption:: .join <amount>
Join the current round and bet <amount> dogecoins
.. cmdoption:: .leave
Leave the current round.
.. cmdoption:: .roll
Once the game has started, roll the dice
Class Reference
---------------

@ -1,7 +1,42 @@
:mod:`DogeWallet` --- A Dogecoin wallet
=======================================
This module provides a dogecoin wallet hosted on the IRC bot's server
This module provides a dogecoin wallet hosted on the IRC bot's server. Using
:doc:`CryptoWallet </api/modules/cryptowallet>` instead is reccommended, this
has many command conflicts with newer modules.
Commands
--------
.. cmdoption:: .setpass (<newpass>|<oldpass> <newpass>)
Create account or change password if account already exists. "Trust" is
based on user's hostname.
.. cmdoption:: .login <password>
Log into the bot (just this module)
.. cmdoption:: .logout
Log out
.. cmdoption:: .setdogeaddr <address>
Set withdrawal address for current user
.. cmdoption:: .getdogebal
Get current user's balance
.. cmdoption:: .withdrawdoge <password> <amount>
With the right <password>, withdraw <amount> to current user's withdrawal
address
.. cmdoption:: .getdepositaddr
Get current user's withdrawal address
Class Reference
---------------

@ -4,8 +4,13 @@
Commands
--------
- *botnick: inventory* - print current inventory
- *botnick: have a x* - give the bot an item
.. cmdoption:: botnick: inventory
Print current inventory
.. cmdoption:: botnick: have a <item>
Give the bot an item
Class Reference
---------------

@ -1,5 +1,15 @@
:mod:`LinkTitler` --- Fetch page titles for URLs posted in chat
===============================================================
:mod:`LinkTitler` --- Fetch url information
===========================================
Grabs titles and other info of links posted into the channel.
Supported services:
* Youtube
* Reddit
Other URLs will grab the <title> element for html pages, or Content-Type header
and length for any other kind of file.
Class Reference
---------------

@ -4,7 +4,10 @@
Commands
--------
- *.randomquote .randquote .rq* - fetch and say a random quote
.. cmdoption:: .rq
.. cmdoption:: .randquote
fetch and say a random quote
Class Reference
---------------

@ -4,10 +4,17 @@
Commands
--------
- *.at <time>* - remind at a specific time.
Example: *.at 20:45EST Do your homework!*
- *.in <time>* - Remind after an amount of time.
Example: *.in 1week5d2h1m Go fuck yourself*
.. cmdoption:: .at <time>
Remind at a specific time.
Example: ``.at 20:45EST Do your homework!``
.. cmdoption:: .in <time>
Remind after an amount of time.
Example: ``.in 1week5d2h1m Go fuck yourself``
Class Reference
---------------

@ -1,10 +1,14 @@
:mod:`Seen` --- !seen <username>
================================
Tracks when nicks were last seen online.
Commands
--------
- *!seen <username>* - finds the last time <username> was online
.. cmdoption:: !seen <username>
Finds the last time <username> was online
Class Reference
---------------

@ -1,11 +1,14 @@
:mod:`Tell` --- Pass messages to a user when they're next seen
==============================================================
:mod:`Tell` --- Message passer
==============================
Queue messages to pass a user when they're next seen.
Commands
--------
- *.tell <user> <message>* - When <user> is next seen online, they will be
a PM with <message>.
.. cmdoption:: .tell <user> <message>
When <user> is next seen online, they will be sent a PM with <message>.
Class Reference
---------------

@ -4,7 +4,9 @@
Commands
--------
- *.urban* - fetch a random fact from Urban Dictionary
.. cmdoption:: .urban
fetch a random fact from Urban Dictionary
Class Reference
---------------

@ -4,13 +4,26 @@
Commands
--------
- *.weather <location>*, *.w <location>* - fetch weather for a locaiton. If no location is passed, the user's preferred location will be used.
Example: *.w 95051*
- *.setloc <location>* - set your preferred location
Example: *.setloc Rochester, NY*
*.setloc 14623*
- *.wunit <type>* - set your preference between fahrenheit or celsius.
Example: *.setloc F*
.. cmdoption:: .weather <location>
.. cmdoption:: .w <location>
Fetch weather for a location. If no location is passed, the user's
preferred location will be used.
Example: ``.w 95051``
.. cmdoption:: .setloc <location>
Set your preferred location
Example: ``.setloc Rochester, NY``, ``.setloc 14623``
.. cmdoption:: .wunit <type>
Set your preference between fahrenheit or celsius.
Example: ``.setloc F``
Class Reference
---------------

@ -4,8 +4,12 @@
Commands
--------
- *.youtube <query>*, *.yt <query>* - search youtube for keywords <query>
Example: *.yt cute cats*
.. cmdoption:: .youtube <query>
.. cmdoption:: .yt <query>
Search youtube for keywords <query>
Example: ``.yt cute cats``
Class Reference
---------------

@ -261,6 +261,7 @@ class gameObj:
def gamePlayTimeoutExpired(self):
# Time out - return doges
self.master.bot.act_PRIVMSG(self.channel, "Time expired! Returning all doges.")
# TODO: Option beteen this and user surrenders their coins on timeout
if self.step == 3:
# In game step. Refund doges
for player in self.players:

Loading…
Cancel
Save