WAMPlius

A Discord bot version of WAMPli. Of course unless you actually know about WAMPli this does't really help, does it? So what exactly is it?

WAMPlius is a Discord bot which makes it possible to interact with the WAMP protocol from the comfort of your Discord server. You can call procedures, publish events to a topic, and subscribe to topics.

Running
Commands
- WAMP
- General

Running

There are two ways you can run the bot yourself. In both cases you need a bot token which you can get by creating an Application and then enabling the bot.

Once you have a token you can then start the bot:

Using Docker

The recommended way to run the bot is using Docker. You can use the image gieseladev/wamplius-bot/wamplius from the GitHub registry. i.e. docker pull docker.pkg.github.com/gieseladev/wamplius-bot/wamplius

$ docker run --env BOT_DISCORDTOKEN="<your token>" gieseladev/wamplius

Arguments are passed to the CLI (see Command-line interface).

Unless the "config" argument is provided, the bot tries to read /config.toml as its configuration file. If you want to configure the bot using a config file instead of environment variable you can mount it there.

For more information regarding configuration see Configuration.

Manually

Instead of using Docker you can of course run the bot manually. The bot is written for python 3.7 and as such you need to have it installed to run it.

You also need to install the dependencies which can be done using Pipenv. Unless you already have it installed, run the following command to install it:

$ python -m pip install -U pipenv

To then install the dependencies run:

$ pipenv install

Once installed you can start the bot using:

python wamplius

See the next section for instructions on how to use the command-line interface.

Command-line interface

usage: wamplius [-h] [-c CONFIG]

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        specify config file

Running the command starts the bot and waits until the bot is shutdown. You can pass the optional config argument to specify the location of the config file.

By default the bot reads the config from "config.toml" in the current working directory if the file exists. Note that you don't have to use a configuration file. Refer to the Configuration section for more details.

Configuration

The bot uses konfi for configuration, specifically the FileLoader and Env sources. If you're not familiar with konfi you can safely ignore what you just read.

The bot can be configured using a file config (YAML or TOML) or using environment variables. Of course these methods aren't exclusive, just know that an environment variable takes precedence over and thus overwrites the same value specified in a config file.

So what values can and do you actually have to configure?

Required values

Key	Environment	Description
`discord_token`	`BOT_DISCORDTOKEN`	Discord bot token of your Application's bot.

Optional values

Key	Environment	Description	Default
`command_prefix`	`BOT_COMMANDPREFIX`	Specify the command prefix the bot should listen to.	">"

Commands

The following is a list of commands supported by the bot.

WAMP

Commands provided by the WAMPlius cog.

Command	Description
`status`	Display the status of the connection for the context (guild or DM).
`connect [<url> <realm>]`	Connect to a WAMP router. The url and realm arguments can be omitted if WAMPlius has a connection configured for the context.
`disconnect`	Disconnect from the WAMP router. The previous configuration is preserved, so calling `connect` without arguments will re-connect.
`call <procedure> [arg]...`	Call a procedure.
`publish <topic> [arg]...`	Publish an event to a topic.
`subscriptions`	Display all subscribed topics and their channel.
`subscribe <topic>...`	Subscribe to one or more topics. Events from the topics will be displayed in the channel the command is executed in.
`unsubscribe <topic>...`	Unsubscribe from one or more topics.
`alias list`	List all URI aliases.
`alias add <name> <uri>`	Add a new alias name which resolves to uri.
`alias remove <name>`	Remove an alias by its name.
`macro <name>`	Run the macro name.
`macro list`	List all macros.
`macro add <name> (call｜publish) <uri> [arg]...`	Add a new macro name which either calls or publishes the uri with the arguments.
`macro remove <name>`	Remove the macro name.

General

Command	Description
`help [command]`	Display usage and description of the command. If no command is given, display help for the bot.
`version`	Show the version of the bot and important libraries.
`shutdown`	Perform a clean shutdown.

gieseladev/wamplius-bot