README.md

RoboFlask

RoboFlask, the modular, really powerful discord bot.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Building
3. Roadmap
4. Contributing
5. License
6. Community and links
7. Acknowledgements

About The Project

RoboFlask is a discord bot, utilizing the Discord API with the use of JDA. It is a modular and powerful bot with plug-in support. Want to create a custom feature for your discord guild using RoboFlask? No worries. This software can be distributed any-how as long as initial credits are given. For more information, see the LICENSE.txt file.

This software is not hosted in any way, shape or form. You, the end-user would have to create an instance of this software to use it properly. Check out this guide for more information on how to host you're RoboFlask bot.

Features

• feature 1
  • sub-feature 1
  • sub-feature 2
• feature 2
• feature 3
• feature 4

Built With

• Java 15
• Maven
• Discord JDA (API Wrapper)

Getting Started

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

Prerequisites

• Java 15
  • This does not usually ship with any IDE's.
    General Installation Guide
• Maven
  • Usually ships with Eclipse or IntelliJ IDEA .
    General Installation Guide

Building

1. Clone the repo

   git clone https://github.com/devflask/RoboFlask.git
2. Build the project

   mvn -B package --file ./RoboFlask/pom.xml
3. The shaded, newly built jar file can now be found in /RoboFlask/target/

Note: If there are issues building your jar file. Make sure you have the correct Java version installed.

Roadmap

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

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.

Community

Repository: https://github.com/devflask/roboflask
Discord: https://discord.gg/wJsBFhD96W
Website: http://devflask.com
Project Link: http://devflask.com/projects/roboflask

Acknowledgements

• Jolly - Contributor ❤️
• Jamie - Contributor ❤️
• Dehys - Contributor ❤️