- Stats per user (message counts; word counts including nouns, verbs and adjectives)
- Stats per channel (message counts; chatty users)
- Stats per server (message counts; chatty users)
- CapyCoin integration (optional!)
This bot records statistics and does NOT record whole messages.
However, it will tokenise messages into words and classify them, and store
those tokens and a count (per user). These are stored in the userwords table.
The bot maintains a users table and a channels table which contains
the ID and name of those discord objects.
The messages table contains the Message ID, Channel ID, User ID and
Timestamp of the message.
- Python 3.12
- UV https://docs.astral.sh/uv/
- KX kdb+ (Personal use licences are available free of charge from https://code.kx.com/q/learn/licensing)
- Run
uv sync --locked
You should follow the steps provided by discord.py to set up a
Discord application and token: https://discordpy.readthedocs.io/en/stable/discord.html#discord-intro
These instructions are quite involved, and it is recommended you invite the bot into a personal testing server first.
Please do not add this bot into a server without understanding the privacy implications. Even though a discord server could be considered a public forum, it is good manners to obtain an understanding from the server community before adding this bot.
Configuration is via environment variables. By default run-bot.sh and run-kdb.sh
will source .env as part of their startup.
-
DUCKBOT_TOKEN: Discord bot token. -
DUCKBOT_LANG_MODEL: If you wish to use a different spacy language model, you can set this. Defaults toen_core_web_md. This model is fairly simple but it is also compact in terms of memory/disk usage. -
KDB_HOST: kdb+ server host (defaults tolocalhost) -
KDB_PORT: kdb+ server IPC port (defaults to5000) -
KDB_USER: kdb+ auth user (defaults to None) -
KDB_PASS: kdb+ auth password (defaults to None) -
KDB_Q_PATH: Path to kdb+qbinary. Used byrun-kdb.sh. -
FORTUNE_PATH: Path tofortunebinary. Defaults to/usr/games/fortune. -
CAPYCOIN_HOST: URL to a CapyCoin gateway. See: https://github.com/lmartinking/capycoin -
CAPYCOIN_USERS_DB_PATH: Path for SQLite database file used for Discord User to CapyCoin account ID mapping
- Set up discord application (per above). Invite bot to server(s).
- Follow instructions under requirements (in a terminal)
- Copy
env.exampleto.envand edit $ ./run-kdb.sh(in one terminal)$ ./run-bot.sh(in another terminal)
@duckbot help- the bot will print a help overview to the channel@duckbot stats @user- print stats for a particular user@duckbot stats #channel- print stats for a particular channel@duckbot stats server- print stats for the whole server@duckbot fortune- send a fortune to the current channel@duckbot ping- the bot will respond "pong" to the user
These commands are only enabled when CAPYCOIN_HOST is set.
@duckbot coin signup- sign up for a CapyCoin account@duckbot coin send @user {amount}- send coin to a user@duckbot coin funds- show your account funds
This code is licenced under the GPLv2.