Leek is a simple and easy to use Discord Bot created by Lemon. It contains a very diverse set of tools that can be enabled or disabled as you wish.
Right now, it has the following features:
- Hyperping: Reports Healthchecks to Hyperping when the Bot is running
- Log Diagnoser: Diagnoses the Log files of ScriptHookVDotNet, giving a quick suggestion for fixes
- Native Lookup: Allows you to search for GTA V and RDR2 natives from Discord
- Moderation: Some simple moderation functions that are not yet implemented in Discord
- Tags: Allows you to write, save and show different Tags with messages
- GitHub Image
- GitHub Releases
- GitHub Actions (experimental versions)
The recommended way to use the Leek bot is via the Docker container. You can pull the image with docker pull ghcr.io/justalemon/leek, which can then be used directly or via Docker Compose. You can use the provided docker-compose.yml as a template.
You can also install the Python package directly to the system interpreter with pip install https://github.com/justalemon/Leek/archive/master.zip.
If you want to install from git for development purposes, you can also run the following commands:
git clone https://github.com/justalemon/Leek.git leek
cd leek
pip install -e .
Leek allows you to configure your bot just by using environment variables via the terminal or a .env files. The following configuration options are available:
- DISCORD_TOKEN: The Discord Bot Token (required)
- DISCORD_DEBUG: Whether Debug features are enabled or not (optional, set it to anything other than zero to enable)
- DISCORD_GUILDS: The guilds that will be set to Debug mode (optional, comas separated guild ids)
- DISCORD_COGS: The Cogs to load by default (optional, separated by comas in the format
library.path:Class) - SQL_HOST: The host for the SQL connection (optional, defaults to
127.0.0.1) - SQL_PORT: The port for the SQL connection (optional, defaults to
3306) - SQL_USER: The user for the SQL connection (optional, but required if you want to use SQL support)
- SQL_PASSWORD: The password for the SQL connection (optional, but required if you want to use SQL support)
- SQL_DB: The name of the SQL database (optional, defaults to
discord) - SQL_WARNINGS: The warning filter used for the SQL warnings (optional, defaults to
ignore)
- HYPERPING_URL: The URL that will be used for the pings
- HYPERPING_DELAY: The delay used to trigger between each ping
- MODCOMMENTS_DRIVER: The Selenium driver to use for fetching the web pages
- MODCOMMENTS_HEADLESS: Whether to use the Headless mode of Firefox and Chrome, this is enabled by default
After setting the required configuration options, you can start the bot as usual. If you are using the package directly, you can start the bot by using python -m leek.
