Skip to content

Latest commit

 

History

History
140 lines (101 loc) · 4.57 KB

README.md

File metadata and controls

140 lines (101 loc) · 4.57 KB
Raw

Code style: black


GrooveBot

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

Table of Contents

About The Project

alt text

GrooveBot is a bot specially coded for the r/Animusic Discord server. It was created 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.5

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
  • Create a groove.ini file in the project directory. Below is an example of its contents:

Note: You will need a database, local or remote.

[SETTINGS]
token=Nzc4MjYzMjAwMDQyODQ0MTYx.X7PcFg.k-BedTOS3LgoEU6teXsQSi5aVAE
message_on_join=Welcome to the official r/Animusic Discord server!
database_url=sqlite://db.sqlite3
general_channel_id=1625118263628154181
verification_channel_id=176371620648173633
verified_role_id=1625184182632815125

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.