JDA-Utilities

JDA-Utilities is a series of tools and utilities for use with JDA to assist in bot creation.

Version 2.0 Notice

Version 2.0 comes with a lot of big (some breaking) changes to the library.

If you use this library for anything, it is STRONGLY recommended you read this gist which documents all of the changes that have been made.

If you have questions or concerns about any of these changes, please contact Shengaero#9090.

Packages

Since JDA-Utilities 2.0, the library has been split into multiple modular projects, in order to better organize it's contents based on what developers might want to use and not use.

• Command Package
• Commons Package
• CommandDoc Package
• Examples Package
• Menu Package

Visit individual modules to read more about their contents!

Getting Started

You will need to add this project as a dependency (either from the latest .jar from the releases page, or via maven or gradle), as well as JDA.

With maven:

  <dependency>
    <groupId>com.jagrosh</groupId>
    <artifactId>jda-utilities</artifactId>
    <version>2.1</version>
    <scope>compile</scope>
    <type>pom</type>
  </dependency>
  <dependency>
    <groupId>net.dv8tion</groupId>
    <artifactId>JDA</artifactId>
    <version>JDA-VERSION</version>
  </dependency>

  <repository>
    <id>central</id>
    <name>bintray</name>
    <url>http://jcenter.bintray.com</url>
  </repository>

With gradle:

dependencies {
    compile 'com.jagrosh:jda-utilities:2.1'
    compile 'net.dv8tion:JDA:JDA-VERSION'
}

repositories {
    jcenter()
}

Individual modules can be downloaded using the same structure shown above, with the addition of the module's name as a suffix to the dependency:

With maven:

  <dependency>
    <groupId>com.jagrosh</groupId>
    <!-- Notice that the dependency notation ends with "-command" -->
    <artifactId>jda-utilities-command</artifactId>
    <version>2.1</version>
    <scope>compile</scope>
  </dependency>

With gradle:

dependencies {
    // Notice that the dependency notation ends with "-command"
    compile 'com.jagrosh:jda-utilities-command:2.1'
}

Examples

Check out the ExampleBot for a simple bot example.

Other guides and information can be found on the wiki.

Projects

Vortex - Vortex is an easy-to-use moderation bot that utilizes the JDA-Utilities library for the Command Client and some of the menus
JMusicBot - This music bot uses the Command Client for its base, and several menus, including the OrderedMenu for search results and the Paginator for the current queue
GiveawayBot - GiveawayBot is a basic bot for hosting quick giveaways!