bands is an internet relay chat bot.
- covers all relevant portions of rfc's 1459 and 2812.
- ircv3 caps supported are
chghostandmulti-prefix. - concurrent multi-server and multi-channel support.
- awareness of the channel, channel user, server and server user contexts.
- full state maniuplation and hot config reload through private messages on trusted servers.
and many more
# 1. get the compose file
mkdir bands/; cd bands/
curl -LO \
https://raw.githubusercontent.com/gottaeat/bands/master/docker-compose.yml
# 2. create the volume mount
mkdir data/; cd data/
# 3. create a config.yml within this directory following the spec and the
# example below
# 4. compose up
cd ../
docker compose up -d# 1. clone the repo
git clone --depth=1 https://github.com/gottaeat/bands
cd bands/
# 2. uncomment the `build' key and comment out the `image' key inside
# docker-compose.yml to build the image instead of using the one from ghcr
# 3. create the volume mount
mkdir data/; cd data/
# 4. create a config.yml within this directory following the spec and the
# example below
# 5. compose up
cd ../;
docker compose up -d| key | necessity | description |
|---|---|---|
wolfram_api_key |
optional | (str) wolfram alpha api key for module support |
openai_key |
optional | (str) openai key for module support |
quote_file |
optional | (str) path to read/write channel quotes to and from |
doot_file |
optional | (str) path to read/write server points to and from |
servers |
required | list of servers to connect to on startup |
quote_file and doot_file keys, if not specified, will default to
/data/quotes.json and /data/doots.json respectively. regardless of the
values being specified, if they do not exist, bands will attempt to create and
initialize the files.
| key | necessity | description |
|---|---|---|
name |
required | (str) reference name for the network |
address |
required | (str) network address |
port |
required | (int) network port |
passwd |
optional | (str) network password |
botname |
required | (str) bot nick+ident |
tls |
optional | (bool) enable tls, false by default |
verify_tls |
optional | (bool) verify tls, false by default |
scroll_speed |
required if burst_speed | (int) how long the wait before sending multiple lines (fakelag) |
burst_speed |
required if scroll_speed | (int) amount of messages allowed before scroll_speed sleep timer kicks in |
channels |
required | (list of str's) channel list to autojoin on startup |
allow_admin |
optional | (bool) allow authentication and remote control on the server, false by default |
secret |
required if allow_admin | (str) authentication secret |
wolfram_api_key: "XXXXX-XXXXXXXXXX"
openai_key: "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
servers:
- name: privnet
address: irc.cooldomain.to
port: 6697
passwd: topsekrit
botname: bands
tls: true
channels:
- "#mychannel"
- "#mychannel2"
allow_admin: true
secret: EsDf/ZcdNp1whuZh
- name: publicnet
address: irc.example.com
port: 6697
botname: stacks
tls: true
verify_tls: true
scroll_speed: 1
burst_limit: 2
channels:
- "#pubchannel"for user-accesible features, call ?help in either the context of a channel or
a private message with the bot.
cmdline specific usage is:
usage: bands [-h] -c C [-d]
bands the irc bot ver. <version>
options:
-h, --help show this help message and exit
-c C path to config yaml
-d enable debug- set at least one of the servers to have
allow_adminand asecret. - privmsg the
botnamewith?auth $secret. - call
?rcon helpfor a list of management related functionality.