/apparatus

Experimental Discord bot for learning purposes

Primary LanguagePythonMIT LicenseMIT

icon

Workflow: CI Code style: black License: MIT

Apparatus is an experimental Discord bot for learning purposes. There exists no public instance of the bot due to its experimental nature. The bot is not optimised to handle large servers, rather, it is designed to offer interesting niche features on smaller servers with less traffic. Most of the features require the bot to cache a considerable portion of - if not the entire - message history on any server it is connected with, to be able to properly carry out its tasks.

The following environment variables can be used to configure the bot:

  • LOG_LEVEL The logging level to use, choices are info, debug and error
  • DISCORD_TOKEN The token used to log in with the bot
  • HISTORY_MINIMUM The minimum message cache size
  • HISTORY_LENGTH Number of messages per channel to cache on startup
  • HISTORY_WEEKS Maximum number of weeks to cache on startup

While the bot is not expected to function properly, any issues can still be reported on the GitHub issue tracker.