Brainy Bot

The Repository for Brainy Bot made with Discord Py

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Project Structure
5. Contributing
6. License
7. Contact

About The Project

Brainy is a free, open source multipurpose discord bot made by Python it lives in Our GDG Algiers Server. Brainy offers many cool features.

Built With

• Python
• DiscordPy

Getting Started

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

Prerequisites

Befor you begin you need to install python and configure A virtual environment if you are in Windows you can just use Conda

• Python [Ubuntu]

  $ sudo apt-get install python3 python3-pip

• VirtualEnv

  $ pip install virtualenv

Installation

1. Clone the repo and cd to it

    $ git clone https://github.com/GDGAlgiers/BrainyBot.git 
    $ cd BrainyBot

2. Create VirtualEnv & Activate environment

    $ virtualenv env 
    $ source env/bin/activate

3. Install Requirements

    $ pip install -r requirements

Usage

1. First you have to create a discord application and get an Application token check out the documentation
2. Set your application token in the configuration files
3. Running The bot

    $ python bot.py 

Project-Structure

The project is split into multiple categories cogs where each category will hold a set of commands here are the current structure : Karma has a lot of features, with 5 main categories:

• 👩‍💼 General: serverinfo, ping, server and 1 more!
• 🤖 Mod: announce
• 👻 Fun: tweet, advice
• ✉️ Help: help
• 👑 Owner: shutdown, say, embed

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/githubName/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/githubName/AmazingFeature)
5. Open a Pull Request

License

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

Contact

GDG Algiers - @gdg_algiers - gdg.algiers@esi.dz

Project Link: https://github.com/GDGAlgiers/BrainyBot