chumbot 0.7.3

A chummy soundboard bot client for Mumble.

Chumbot

The Conveying Harmonies Unto Mumble Bot, or Chumbot, is a Mumble soundboard and notification bot written in Python 3. Chumbot relies on the PYMUMBLE API, which requires the opuslib and protobuf Python libraries as well as libopus being available on the host machine.

Chumbot is currently not supported on Windows.

Installation

For users

The Chumbot client can be installed via pip:

pip install chumbot

For developers

Chumbot can be installed for development by first installing Poetry and running the following command within the project directory:

poetry install

Usage

Chumbot is run from the command line. Audio clips should be stored in mp3 format.

usage: chumbot [-h] [-u USERNAME] [-H HOST] [-P PORT] [-p PASSWORD] [-d]

Chumbot command-line interface

options:
  -h, --help            show this help message and exit
  -u USERNAME, --username USERNAME
                        specify Chumbot's username
  -H HOST, --host HOST  specify the Mumble host address
  -P PORT, --port PORT  specify the Mumble host port
  -p PASSWORD, --password PASSWORD
                        specify the Mumble host password
  -d, --debug           enable debug message printing

Configuration

Chumbot configuration is stored in ~/.config/chumbot.ini. Chumbot must be configured to know where audio files are stored.

Chumbot can be configured to play a specific clip when a link or image is posted or when a user joins or leaves a channel. It can even be configured to play a personalized 'join' or 'disconnect' sound for each user.

An example chumbot.ini:

[mumble]
Username = chumbot
Host = example.murmur.nfoservers.com
Port = 2112
Password = 1234

[clips]
ClipDir = ~/chumbot-clips
LinkPostedClipName = link_clip
UserJoinedClipName = default_join_clip
UserLeftClipName = default_leave_clip

[join]
user1 = join_clip1
user2 = join_clip2
user3 = join_clip3

[disconnect]
user1 = disconnect_clip1
user2 = disconnect_clip2
user3 = disconnect_clip3

Contributing

Contributions are taken and any pull requests will be reviewed by me (eventually).

Please attempt to adhere to the coding practices in .pylintrc. Ensure no pylint warnings are generated before creating a PR.