About

This plugins handles TCP option 201, GMCP (aardwolf implementation)

GMCP

cache

usage: #bp.GMCP.cache [-h] [item]

show an item in the cache

positional arguments:
  item        the item to show

optional arguments:
  -h, --help  show help (default: False)

send

usage: #bp.GMCP.send [-h] [stuff]

send something through GMCP

positional arguments:
  stuff       the item to send through GCMP

optional arguments:
  -h, --help  show help (default: False)

Base

api

usage: #bp.GMCP.api [-h] [api]

list functions in the api

positional arguments:
  api         api to get details of

optional arguments:
  -h, --help  show help (default: False)

help

usage: #bp.GMCP.help [-a] [-c] [-h]

show help info for this plugin

optional arguments:
  -a, --api       show functions this plugin has in the api (default: False)
  -c, --commands  show commands in this plugin (default: False)
  -h, --help      show help (default: False)

inspect

usage: #bp.GMCP.inspect [-m METHOD] [-o OBJECT] [-s] [-h]

inspect a plugin

optional arguments:
  -m METHOD, --method METHOD
                        get code for a method
  -o OBJECT, --object OBJECT
                        show an object of the plugin, can be method or
                        variable
  -s, --simple          show a simple output (default: False)
  -h, --help            show help (default: False)

reset

usage: #bp.GMCP.reset [-h]

reset the plugin

optional arguments:
  -h, --help  show help (default: False)

save

usage: #bp.GMCP.save [-h]

save the plugin state

optional arguments:
  -h, --help  show help (default: False)

set

usage: #bp.GMCP.set [-h] [name] [value]

change a setting in the plugin

if there are no arguments or 'list' is the first argument then
it will list the settings for the plugin

positional arguments:
  name        the setting name (default: list)
  value       the new value of the setting

optional arguments:
  -h, --help  show help (default: False)

stats

usage: #bp.GMCP.stats [-h]

show plugin stats

optional arguments:
  -h, --help  show help (default: False)

sendpacket

GMCP.sendpacket(message)
  send a GMCP packet
    message  = the message to send

    this function returns no values

    Format: IAC SB GMCP <gmcp message text> IAC SE

original defined in plugins/net/GMCP.py

togglemodule

GMCP.togglemodule(modname, mstate)
  toggle a GMCP module
    modname  = the GMCP module to toggle
    mstate  = the state, either True or False

    this function returns no values

original defined in plugins/net/GMCP.py

sendmodule

GMCP.sendmodule(modname)
  send a GMCP module to clients that support GMCP
    modname  = the module to send to clients

    this function returns no values

original defined in plugins/net/GMCP.py

getv

GMCP.getv(module)
  get a GMCP value/module from the cache
    module  = the module to get

    this function returns a table or value depending on what is requested

original defined in plugins/net/GMCP.py