About

This plugin will show information about connections to the proxy

Commands

proxy

clients


usage: #bp.proxy.clients [-h]

list clients that are connected

optional arguments:
  -h, --help  show help

connect


usage: #bp.proxy.connect [-h]

connect to the mud

optional arguments:
  -h, --help  show help

disconnect


usage: #bp.proxy.disconnect [-h]

disconnect from the mud

optional arguments:
  -h, --help  show help

info


usage: #bp.proxy.info [-h]

list proxy info

optional arguments:
  -h, --help  show help

mudpw


usage: #bp.proxy.mudpw [-h] [value]

set the Mud Password

positional arguments:
  value       Mud Password

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

proxypw


usage: #bp.proxy.proxypw [-h] [value]

set the Proxy Password

positional arguments:
  value       Proxy Password

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

proxypwview


usage: #bp.proxy.proxypwview [-h] [value]

set the Proxy View Password

positional arguments:
  value       Proxy View Password

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

restart


usage: #bp.proxy.restart [-h]

restart the proxy

optional arguments:
  -h, --help  show help

shutdown


usage: #bp.proxy.shutdown [-h]

shutdown the proxy

optional arguments:
  -h, --help  show help

Base

api


usage: #bp.proxy.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.proxy.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.proxy.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.proxy.reset [-h]

reset the plugin

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

save


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

save the plugin state

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

set


usage: #bp.proxy.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.proxy.stats [-h]

show plugin stats

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

Settings

username


username

linelen


the line length for data

mudport


the port of the mud

listenport


the port for the proxy to listen on

mudhost


the hostname/ip of the mud

API

proxypw


proxy.proxypw()

    read the secret from a file


original defined in plugins/core/ssc.py

mudpw


proxy.mudpw()

    read the secret from a file


original defined in plugins/core/ssc.py

proxypwview


proxy.proxypwview()

    read the secret from a file


original defined in plugins/core/ssc.py

restart


proxy.restart()

    restart the proxy after 10 seconds


original defined in plugins/net/proxy.py