FeurBot

Explore the docs »
--------------------
Report Bug · Request Feature

Table of Contents

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

About The Project

FeurBot is a Discord bot, developed in Python, that can be used to play music, to do quizzes, to moderate a server, to display hardware statistics, and more.

The old version (v1) can be found here.

(back to top)

Built With

• 
• 

(back to top)

Getting Started

You can install FeurBot on your own server by following these steps.

Prerequisites

1. Clone the repository on your computer.

   git clone https://github.com/Isnubi/FeurBot.git
   cd FeurBot

   • If Git is not installed, you can type the following command in your terminal to install it.

     sudo apt install git

2. Run the install script as user (not root).

   • For Debian-based systems (Debian, Ubuntu, Mint, etc.):

     sudo chmod +x apt_install.sh
     sudo ./apt_install.sh

   If the script didn't work, you can follow these steps.

Installation

1. Get a free Giphy API Key at https://developers.giphy.com/
2. Create a Discord bot at https://discord.com/developers/applications
   • Create a new application
   • Go to the "Bot" tab
   • Click on "Add Bot" and confirm
   • Active the intents options
     
     
   • Copy the token
   • Go to the "OAuth2" tab
     • Select the "bot" scope
     • Select the "applications.commands" scope
     • Select the "Administrator" permission
       
     • Copy the generated URL
     • Invite the bot to your server
3. Enter your bot token, your Giphy API Key and your database informations in private/config.py

   token = 'DISCORD_BOT_TOKEN'
   giphy_api_key = 'GIPHY_API_KEY'
   
   mysql_host = 'DATABASE_HOST'
   mysql_user = 'DATABASE_USER'
   mysql_password = 'DATABASE_PASSWORD'
   mysql_database = 'DATABASE_NAME'

4. Run the bot

   python3 FeurBot.py

(back to top)

Usage

• The bot is using slash commands so you can use them by typing / in a channel.
• You can get the help menu by sending.

  /help <page_number>
  

  You can navigate in it with the reactions.

For more examples, please refer to the help menu of the bot.

(back to top)

Roadmap

• Music system
  • Music player
  • Music commands
  • Music queue

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Isnubi - @Louis_Gambart - [email protected]
Discord: isnubi#6221

Project Link: https://github.com/Isnubi/FeurBot

(back to top)