Skip to content

ghostty-org/discord-bot

Repository files navigation

Ghostty Discord Bot

The Ghostty Discord Bot, humorlessly named "Ghostty Bot."

Development

The Nix environment is the only supported development environment. You can develop this without Nix, of course, but I'm not going to help you figure it out.

Discord Bot

You will have to set up a Discord bot and get a Discord bot token. The instructions for that are out of scope for this README. The Discord bot will require the following privileges:

  • Manage Roles
  • Members Privileged Intents

Nix

Once your environment is set up, create a .env file based on .env.example and run the app:

$ python -m app
...

After you've made your changes, run the linter and formatter:

$ ruff check
$ ruff format

Non-Nix

This bot runs on Python 3.11+ and is managed with Poetry. To get started:

  1. Install poetry (preferably with pipx).
  2. Create a .env file based on .env.example.
  3. Install the project and run the bot:
    $ poetry install
    ...
    $ poetry run python -m app
    ...
  4. After you've made your changes, run the linter and formatter:
    $ poetry run ruff check
    $ poetry run ruff format