Skip to content

Latest commit

 

History

History
121 lines (101 loc) · 3.64 KB

README.md

File metadata and controls

121 lines (101 loc) · 3.64 KB
Raw

JDA-Chewtils

JDA-Chewtils is a modern and updated fork of JDA-Utilities which is a series of tools and utilities for use with JDA to assist in bot creation.

Support

If you're needing help or want to help, feel free to hop onto the #jda-chewtils channel on my server.

Please do NOT use the official JDA server for help with this fork.

Packages

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

Visit individual modules to read more about their contents!

Getting Started

You will need to add this project as a dependency (via Maven or Gradle), as well as JDA.

Keep in mind the 1.x version of JDA-Chewtils is only compatible with JDA 4, for compatibility with JDA 5, you need 2.x. See the wiki for more information.

With Maven:

  <dependency>
    <groupId>pw.chew</groupId>
    <artifactId>jda-chewtils</artifactId>
    <version>JDA-CHEWTILS-VERSION</version>
    <scope>compile</scope>
    <type>pom</type>
  </dependency>
  <dependency>
    <groupId>net.dv8tion</groupId>
    <artifactId>JDA</artifactId>
    <version>JDA-VERSION</version>
  </dependency>
  <!-- Chew's Maven Repo for JDA-Chewtils -->
  <repository>
    <id>chew</id>
    <name>m2-chew</name>
    <url>https://m2.chew.pro/releases</url>
  </repository>
  <!-- JDA repo to get JDA -->
  <repository>
    <id>dv8tion</id>
    <name>m2-dv8tion</name>
    <url>https://m2.dv8tion.net/releases</url>
  </repository>

With Gradle:

dependencies {
    implementation 'pw.chew:jda-chewtils:JDA-UTILITIES-VERSION'
    implementation 'net.dv8tion:JDA:JDA-VERSION'
}

repositories {
    mavenCentral() // for transitive dependencies
    // for JDA 4
    maven {
      name 'm2-dv8tion'
      url 'https://m2.dv8tion.net/releases'
    }
    // For JDA-Chewtils
    maven { url "https://m2.chew.pro/releases" }
}

Gradle (Kotlin):

dependencies {
    implementation("pw.chew:jda-chewtils:JDA-UTILITIES-VERSION")
    implementation("net.dv8tion:JDA:JDA-VERSION")
}

repositories {
    mavenCentral() // for transitive dependencies
    // for JDA 4
    maven {
      name = "m2-dv8tion"
      url = uri("https://m2.dv8tion.net/releases")
    }
    // For JDA-Chewtils
    maven { url = uri("https://m2.chew.pro/releases") }
}

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>pw.chew</groupId>
    <!-- Notice that the dependency notation ends with "-command" -->
    <artifactId>jda-chewtils-command</artifactId>
    <version>JDA-CHEWTILS-VERSION</version>
    <scope>compile</scope>
  </dependency>

With Gradle:

dependencies {
    // Notice that the dependency notation ends with "-command"
    implementaton 'pw.chew:jda-chewtils-command:JDA-CHEWTILS-VERSION'
}

Examples

Guides and information can be found on the wiki.