Getting started

Docker

Pre-requisites

• Docker
• Docker-compose

Steps

1. Clone the repository
2. Rename the file compose.yml.example to compose.yml
3. Change the variables in the file compose.yml under the environment key
4. Run the command docker-compose build to build the image
5. Run the command docker-compose up to start the container

Local Python

Pre-requisites

• Python 3.12
• Pip

Steps

1. Clone the repository
2. Create a virtual environment using the command python -m venv venv
3. If on Windows, activate the virtual environment using the command .\venv\Scripts\activate
4. If on Linux, activate the virtual environment using the command source venv/bin/activate
5. Install the dependencies using the command pip install -r requirements.txt
6. Setup local environment variables
7. Run the command python main.py

Recommendations

I'd recommend using Docker as it's easier to setup and run the application. If you're familiar with Python, you can use the local setup instead. This is a simple application and doesn't require much setup. It should really only be used on a single guild as it doesn't have any database support.

Configuration

Environment Variables

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

Required Variables

• BOT_TOKEN - The Discord bot token obtained from the Discord Developer Portal

Optional Variables

• CHANNEL_ID - The Discord channel ID where the bot will post daily random cards.
• CRON_SCHEDULE - When to post the daily random card (in cron format).
• TZ - Timezone for the cron schedule. Default: America/New_York

Command Toggle Variables

All command toggle variables default to true. Set to false to disable specific commands.

• ENABLE_RANDOM_COMMAND - Controls the /random-card command
• ENABLE_CARD_INFO_COMMAND - Controls the /card-info command
• ENABLE_IMAGE_COMMAND - Controls the /image command
• ENABLE_PRICE_COMMAND - Controls the /price command
• ENABLE_RULINGS_COMMAND - Controls the /rulings command
• ENABLE_LEGALITY_COMMAND - Controls the /legality command
• ALLOW_READ_MESSAGE - Controls reading reading user messages for card names and looking up the card on Scryfall

Features

• Can optionally set a automated message to be sent at a specific time to a specific channel (Ommit the variables for CHANNEL_ID and CRON_SCHEDULE to disable this feature)
• Handles double sided cards and posts both images