bwc9876.dev
The world's most clever kitty cat
1# Bingus Bot
2
3A very clever kitty
4
5Simple markov chain-based auto replies to user messages.
6
7## Installation
8
9Use the NixOS module in this flake or build/set it up yourself. Just need Rust.
10
11### Discord Setup
12
13This bot will need the "Message Content" privileged gateway intent to learn from messages.
14
15It will also need the ability to send messages and read the message history of channels.
16
17## Configuration
18
19### `TOKEN_FILE`
20
21Path to the file containing the bot's token.
22
23### `BRAIN_FILE`
24
25Path to the file Bingus will save state in. The file will be created if not present. This will be a brotli-compressed MsgPack file.
26
27### `REPLY_CHANNELS`
28
29Comma-delimited list of channel IDs that Bingus should auto reply in.
30
31Bingus will learn from all channels he has access to but will only auto-reply in these ones.
32
33To retrieve this ID, enable developer mode in your client and right click the channel you wish to use, then click "Copy Channel ID".
34
35## Commands
36
37Commands with `*` require you to be the owner of the bot. Create a team in the Discord
38dev portal to make multiple people owner.
39
40- `/markov`: For a reply from Bingus in the current channel
41- `/weights`: View the weights for a specific token
42- *`/dump_chain`: Dump Bingus' "brain", his entire database of known words and relations
43- *`/load_chain`: Additively load a brain file into Bingus
44