This repository contains source for WhoIS Bot, a Discord bot written in Python that provides server wide notes for users, to allow easier tracking of who a user is beyond changing nicknames/cryptic usernames.
The bot can be run in any Python environment, but this repository includes a Dockerfile to run the bot in a Docker container.
The Docker image is publish on DockerHub.
If running locally, you must install the dependencies from requirements.txt, ideally in a virtual environment.
$ python -m venv env
$ source env/bin/activate
$ pip install -r requirements.txt
The bot requires the following environment variables to function. These are required in both the local and Docker environments.
| Variable | Description |
|---|---|
| DISCORD_TOKEN | The token used by the Discord bot to authenticate with Discord. |
| DISCORD_GUILD | The name of the discord server you want to monitor |
| DISCORD_ROLE | The name of the role to use for users to monitor (allows skipping bots/other) |
| DICT_PATH | The path to store the pickled dictionary for persistent notes. |
The following commands are available.
| Command | Description |
|---|---|
| $help | Shows a list of available commands |
| $list | list all nicknames/notes |
| $user "{nickname/username}" | Shows the record for a specific user. |
| $note "{nickname/username}" "{note}" | Sets the note for the given user |
Content type
Image
Digest
Size
46.8 MB
Last updated
about 5 years ago
docker pull nealon/whois-bot