The purpose of this project is to act as a middleware between the OctoPrint-DiscordRemote plugin and discord. Originally, the plugin used discord.py, however, as discord.py advanced, it started to drop support for older python version. Separating the Discord and Octoprint parts of the plugin was the solution chosen, however, it has a few pros and cons:
- Complete separation and decoupling of discord and plugin.
- Simpler API, but only supports a subset of discord functionality.
- Multi-tenant, a single DiscordShim can support multiple Octoprint plugins
- No more requirement on creating a discord bot, new users can just use the existing bot
- Power users can self-host DiscordShim for themselves.
- There are privacy concerns, as the central DiscordBot sees all messages on all servers that it is added to.
Fastest way to setup the bot is to use the Docker Compose scripts.
cat <<EOT >> .env
BOT_TOKEN='$LIVE_BOT_TOKEN'
EXTERNAL_PORT=23416
EOT
docker-compose up --build -dCI is hosted on a private gitlab, this is a mirror. If you wish to make a contribution, make a fork and MR as per standard github processes, and the merge will be made by the myself manually.
There are some rust unit tests, but no where near covered well enough.
Run with cargo test
The python tests allow testing the shim end-to-end.
Run with:
# Start DiscordShim
BOT_TOKEN=$LIVE_BOT_TOKEN cargo run
# Start tests
BOT_TOKEN=$LIVE_BOT_TOKEN DISCORDSHIM_ADDR=127.0.0.1 DISCORDSHIM_PORT=53416 pytest