Skip to main content

A Discord bot for SpellTable

Project description

SpellBot

build pypi codecov python black mit

A Discord bot for SpellTable.

add-bot

ko-fi

🤖 Using SpellBot

Once you've connected the bot to your server, you can interact with it over Discord via the following commands in any of the authorized channels.

  • !help: Provides detailed help about all of the following commands.
  • !about: Get information about SpellBot and its creators.

✋ Queueing

  • !play: Get in line to play some Magic: The Gathering!
  • !leave: Get out of line; it's the opposite of !play.
  • !status: Show some details about the queues on your server.

👑 Administration

  • !spellbot: Admin subcommands to configure SpellBot for your server.

Subcommands:

  • channels: Set the channels SpellBot is allowed to operate within.
  • prefix: Set the command prefix for SpellBot in text channels.
  • scope: Set the matchmaking scope to server-wide or channel-specific.

🙌 Support Me

I'm keeping SpellBot running using my own money but if you like the bot and want to help me out, please consider donating to my ko-fi.

❤️ Contributing

If you'd like to become a part of the SpellBot development community please first know that we have a documented code of conduct and then see our documentation on how to contribute for details on how to get started.

🔧 Running SpellBot Yourself

First install spellbot using pip:

pip install spellbot

Provide your Discord bot token with the environment variable SPELLBOT_TOKEN. As well as your SpellTable API authorization token via SPELLTABLE_AUTH. You can get your bot token from Discord. As for the SpellTable API authorization token, you'll have to talk to the SpellTable developers. You can join their Discord server by becoming a SpellTable patron.

By default SpellBot will use sqlite3 as its database. You can however choose to use another database by providing a SQLAlchemy Connection URL. This can be done via the --database-url command line option or the environment variable SPELLBOT_DB_URL. Note that, at the time of this writing, SpellBot is only tested against sqlite3 and PostgreSQL.

More usage help can be found by running spellbot --help.

🐳 Docker Support

You can also run SpellBot via docker. See our documentation on Docker Support for help.


MIT © amy@lexicalunit et al

Project details


Release history Release notifications | RSS feed

This version

2.2.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spellbot-2.2.0.tar.gz (19.7 kB view hashes)

Uploaded Source

Built Distribution

spellbot-2.2.0-py3-none-any.whl (19.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page