Skip to content

Latest commit

 

History

History
63 lines (44 loc) · 1.94 KB

README.md

File metadata and controls

63 lines (44 loc) · 1.94 KB
Raw

discord-python-starter

A starter template for making discord bots with Honcho that are deployed to fly.io

The main logic for the discord bot is in the bot.py file. It contains 2 functions.

  • on_message — the event that is run when a message is sent to the server the bot is in
  • restart — A discord slash command called restart. It is used to close the session and create a new one

The template uses openrouter for LLM inferences and supports all the LLMs on there

Getting Started

This project uses python with poetry for dependency management. The main two dependencies are Honcho and pycord.

To get started, run poetry install

With poetry, you can start a poetry shell to initiate a virtual environment for the project.

From here you can edit the bot.py file to add whatever logic you want for the 3 methods described above. Additional functionality can be added to the bot. Refer to the py-cord documentation

Environment Variables

The repo contains a .env.template file that shows all the default environment variables used by the discord bot. Make a copy of this template and fill out the .env with your own values.

cp .env.template .env

Caution

Make sure you do not push your .env file to GitHub or any other version control. These should remain secret. By default the included .gitignore file should prevent this.

Docker

The project uses Docker for packaging the bot code and providing a single executable to start the bot. The below commands will build the docker image and then run the bot using a local .env file.

docker build -t discord-bot .
docker run --env-file .env discord-bot

Deployment

The project contains a generic fly.toml that will run a single process for the discord bot.

To deploy the bot, run fly deploy