About

This is a mud proxy. It runs in python 2.X (>2.6).

It supports MCCP, GMCP, aliases, actions, substitutes, variables

Installation

Git

• git clone https://github.com/endavis/bastproxy.git

Download

• Download the zip file from here.
• Unzip into a directory

Getting Started

Starting

• From the installation directory, python bastproxy.py

usage: bastproxy.py [-h] [-p PORT] [-d]

A python mud proxy

optional arguments:
  -h, --help            show this help message and exit
  -p PORT, --port PORT  the port for the proxy to listen on
  -d, --daemon          run in daemon mode

Connecting

• Connect a client to the listen_port above on the host the proxy is running, and then login with the password
  • Default Port: 9999
    • to set a different port after logging in #bp.proxy.set listenport portnum
  • Default Password: "defaultpass"
    • to set a different password after loggin in #bp.proxy.proxypw "new password"
  • Setting up the mud to connect to
    • to set the mud server #bp.proxy.set mudhost some.server
    • to set the mud port #bp.proxy.set mudport portnum
  • Setting up autologin
    • to set the user #bp.proxy.set username user
    • to set the password #bp.proxy.mudpw password
  • Connecting to the mud
    • #bp.proxy.connect

Help

• Use the following commands to get help
  • Show command categories
    • #bp.commands
  • show commands in a category
    • #bp.commands.list "category"
    • #bp."category"
  • Show loaded plugins
    • #bp.plugins
  • Show plugins that are not loaded
    • #bp.plugins -n

Basics

Plugins

• Plugins are the basic building block for bastproxy, and are used through the commands that are added by the plugin.

Commands

Help

• Any command will show a help when adding a -h

Arguments

• command line arguments are parsed like a unix shell command line
• to specify an argument with spaces, surround it with double 's or "s
  • Examples:
  • #bp.plugins.cmd first second
    • 1st argument = 'first'
    • 2nd argument = 'second'
  • #bp.plugins.cmd 'this is the first argument' "this is the second argument"
    • 1st argument = 'this is the first argument'
    • 2nd argument = 'this is the second argument'