JunkShip Documentation

## JUNKSHIP COMMANDS ##

## GOOGLE ##
## .g , .google and .gis are all valid command hooks. .gis will search IMAGES ONLY.


## YOUTUBE ##
## .y , .yt and .youtube are all valid command hooks. Will return whatever is relevant to your query.


## TELL ##
## .tell <user> <message> -- bot will relay your specified message to the user when the user is next seen
    ## .showtells -- has the bot bring up all tells sent to you by a user.
## There is a hard cap of FIVE (5) on how many tells can be sent to a user. If you go over this limit, tough luck.


## DICE ##
## .dice #df (+#) / d## -- performs a dice roll. DISCLAIMER: Katherine is not responsible for the bot dicking you over.
    ## Passive dice-rolling enabled. Command prefix is not required.
## EXAMPLE:
[ <@DrRosch> 4df+5 MDEF example roll
<JunkShip> DrRosch: MDEF example roll: 7 (4df+5=0, 0, +, +) ]


## SEEN ##
## .seen <user> -- will return how long ago the specified user was last seen, along with their last message sent.


## REM ##
## .rem <hook> <body> -- allows a user to have the bot 'remember' something. USEAGE:
[ <@DrRosch> .rem docs - Documentation https://link-example.com/abcdefg12345
<JunkShip> DrRosch: done.
<@DrRosch> ?docs
<JunkShip> docs - Documentation https://link-example.com/abcdefg12345 ]
    ## To have the bot forget a rem, do ' .for <hook> ' e.g ' .for docs '
    ## To append something to a rem, do ' .rem <hook> + <addition> ' e.g ' .rem docs + | Alt link: https://link-example.com/zyx098
    ## To replace a word/phrase in a rem, do ' .rem <hook> s/keyword/newkeyword ' e.g ' .rem Bot s/butts/butt '
    [ <@DrRosch> .rem Bot - The bot is a butts
    <JunkShip> DrRosch: done.
    <@DrRosch> .rem bot s/butts/butt
    <JunkShip> DrRosch: replacing 'butts' with 'butt' in - The bot is a butts
    <@DrRosch> ?bot
    <JunkShip> bot - The bot is a butt ]


## QUOTE ##

## .quote/.q add|del <user> <message> -- stores user quotes in a shitty database or something. USEAGE:
[ <@DrRosch> .q add DrRosch ASSFUCK.
<JunkShip> DrRosch: quote added.
<@DrRosch> .q DrRosch
<JunkShip> DrRosch: [1/1] 2017-10-14 <DrRosch> ASSFUCK. ]
    ## .q <user> -- will return a random quote belonging to the specified user. Doing ' .q <user> # ' will specify a particular quote corresponding to the specified numerical value (represented by #).
    ## This is awful but apparently deleting quotes is a Broken Thing(tm).


## PING ##

## .ping -- Bot will respond with 'pong' directed at the user. Lets you know if you're connected I s'pose. Probably one of the shortest lines of code in this thing.
###
from util import hook

@hook.command
def ping(pong)
    return pong + "pong"
###

## BOTSNACK ##

## botsnack -- just a weird feature. The bot deserves rewards too!
[ <@DrRosch> botsnack
<JunkShip> [happy bot noises!!] ]
###
from util import hook

@hook.regex("botsnack")
def snack(match):
    return "[happy bot noises!!]"
###
## JUNKSHIP IS A FORK OF RMMH'S SKYBOT. JUNKSHIP CURRENTLY RUNS ON PYTHON 2.7+.
## JunkShip last updated 14-10-2017