petersimeth / beardlessbot

A Discord bot supporting faux gambling (coin flips and blackjack), a currency system, fun facts, and more.

Beardless Bot

Full Release 1.6.12

A Discord bot supporting gambling (coin flips and blackjack), a currency system, fun facts, and more.

Originally created for use in eggsoup's discord server.

If you just want to add the bot to your own Discord server while I host it, you can simply click this link, then skip down to Setup. If you want to run your own instance of Beardless Bot, follow the steps outlined directly below in Installation.

Installation

1. Download the repository.

2. Download Python 3, and then run pip3 install -r resources/requirements.txt.

3. Create a file named "token.txt" that contains your Discord API token (you can get a token here).

4. Place the token file in the resources folder.

5. As of Full Release v1.3.0, Beardless Bot supports calls to the Brawlhalla API. If you don't have an API key, those commands will simply be disabled; the Bot will work fine. If you do have an API key, place it in a file named "brawlhallaKey.txt" in the resources folder. If you want to fork this repo and have Brawlhalla commands covered by unit tests, you'll need to define a repository secret with the name BRAWLHALLAKEY. For more information, see this guide.

Setup

• To use the !spar command, create a channel named looking-for-spar.

• To use Beardless Bot's event logging, create a channel named bb-log.

• To use special colors, create roles named special red, special blue, special pink, and special orange.

Contributing to Beardless Bot

Interested in improving Beardless Bot? Great! If you have an idea, feel free to open a Pull Request with an explanation of what your changes accomplish. There are also several issues open in the Issues tab that could use someone tackling them. Please make sure your code is PEP8 compliant, with a column limit of 80.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.