thestarboard

A discord bot for providing democratic preservation of memorable messages in a starboard channel!

(Photographed by Makia Minich, CC-BY-SA 3.0)

Contributing

Want to add translations? Fork this repository, create a new branch, commit your PO files there, then make a pull request. See discord.py-gettext-demo's onboarding for more information.

Setup

It is recommended to use Docker Compose for running this bot. To start:

1. Clone this repository:

   git clone https://github.com/thegamecracks/thestarboard
   cd thestarboard

2. Create a config.toml file containing your bot token:

   [bot]
   token = "Bot token from https://discord.com/developers/applications"

3. Create a .env file to be used by Docker Compose:

   PGPASSWORD=admin

4. Start all services using docker compose up --build --exit-code-from app

5. To clean up the services, run docker compose down --volumes.

If you would like to run the bot in your own system while separately providing its required services, you can install the bot as a package:

pip install .
python -m thestarboard

Note that Python 3.11 or newer is required.

License

This project uses the MIT License.