Compass Bot

| Documentation | Invite Compass |

Compass is a general Discord bot written in Python and hosted on DigitalOcean.

This repository contains the source code for Compass, as well as the documentation for the bot, and can be used as a template for creating your own Discord bot.
(If you use this repository as a template, please give credit to the original author(s))

If you have any questions, suggestions, or feedback, please feel free to create an issue, or message me on Discord directly (glass.ships#4517)!

For guided instructions on creating a Discord bot in C# or Python, see Fatcatnine's Thinbotnine repository (soon TM)

Dependencies

• Python >= 3.11
• Poetry
• libffi-dev
• libnacl-dev
• libopus0

Development - Running the bot

• Install system dependencies:
  sudo apt install -y libffi-dev libnacl-dev libopus0 build-essential libssl-dev libffi-dev libxml2-dev libxslt1-dev zlib1g-dev
  (or equivalent for your system)

• Install Poetry and Python if needed.

• Clone the repository:
  git clone https://gitlab.com/glass-ships/compass-bot.git

• Install Compass and its dependencies:
  poetry install

• Start the bot:
  poetry run compass [OPTIONS] start [ARGS]

For more information, see the documentation, or run poetry run compass --help for a list of available commands.

Contributing

| Issues |

We'd love to have you contribute to Compass!
Feel free to create an issue or pull request if you have any questions, suggestions, or feedback.