Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.77 KB

README.md

File metadata and controls

67 lines (41 loc) · 2.77 KB
Raw

Build Status Version version (SNAPSHOT)

Vramework

Vramework is a framework for creating Discord bots using DV8FromTheWorld's JDA as its backend.

This framework can :

  • manage commands simply by creating a new class in a package;
  • deal with different languages;
  • handle settings;
  • create an automatic help list;

and much more!

Getting Started

These instructions will allow you to start writing up your own bot using our framework.

Prerequisites

You will require Maven and Java >1.8 to use our framework.

Maven could be installed through most Java IDE : your mileage may vary.

Installing

Maven

<dependency>
  <groupId>io.github.vhoyon</groupId>
  <artifactId>vramework</artifactId>
  <version>LATEST</version>
</dependency>

(you can switch LATEST to the following version number : Version)

TODO : Describe how to start up with this framework.

We know, it's quite important. We'll do it ASAP! :)

Built With

  • JDA - The Java Discord APIs to allow a bot to run in Java
  • Maven - Dependency Management
  • ClassGraph - Used to find Commands without declaring them

GitFlow

We use a slightly modified GitFlow methodology, where our modifications types are used when creating branches from the dev branch. For example, creating a README.md file means creating a branch from dev named tasks/README.

ZenHub

We use ZenHub to easily manage our issues. If you haven't tried it yet, we highly recommend it, inline GitHub integrations for issues management is really useful!

Authors

  • Guillaume Marcoux (V-ed) - Owner and main maintainer
  • Stephano Mehawej (StephanoMehawej) - Maintainer

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details