GrooveBot

The official r/Animusic Discord bot.
Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License

About The Project

GrooveBot was created for the r/Animusic Discord server. Used as an easy way to reference Wayne Lytle's, David Crognale's, and other's work as well as understand abbreviations that may be used within the server. There are also security features such as verification, user strikes, and join/leave messages.

v3.1.7

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

First install pip, which contains all of the necessary packages.

• pip

sudo apt install python3-pip

Installation

• Clone the repo

git clone https://github.com/sunset-developer/GrooveBot

• Install Pip Packages

pip3 install -r requirements.txt

• Make desired changes to Groovebot's config dictionary in groove.py, below is an example of its contents:

config = Config(
    {
        "TOKEN": "Nzc4MjYzMjAwMDQyODQ0MTYx.X7PcFg.k-BedTOS3LgoEU6teXsQSi5aVAE",
        "MESSAGE_ON_JOIN": "Welcome to the official r/Animusic Discord server!",
        "DATABASE_URL": "sqlite://db.sqlite3",
        "WELCOME_CHANNEL_ID": "1625118263628154181",
        "VERIFICATION_CHANNEL_ID": "176371620648173633",
        "VERIFIED_ROLE_ID": "1625184182632815125"
    }
)

Any environment variables defined with the GROOVEBOT_ prefix will be applied to the config. For example, setting GROOVEBOT_TOKEN will be loaded by the application automatically and fed into the TOKEN config variable.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.