Skip to content
This repository has been archived by the owner on Oct 30, 2022. It is now read-only.
Bastian Oppermann edited this page Nov 16, 2017 · 8 revisions

Welcome to the sdcf4j wiki!

Sdcf4j is a simple Discord command framework for Java, supporting Javacord, JDA and Discord4J. It helps you creating commands within seconds in a clean and simple way.

A ping command is as easy as this:

@Command(aliases = "!ping", description = "Pong!")
public String onPingCommand() {
    return "Pong!";
}

Download

Sdcf4j uses Maven to manage it's dependencies.

<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>
...
<!-- The core module -->
<dependency>
  <groupId>de.btobastian.sdcf4j</groupId>
  <artifactId>sdcf4j-core</artifactId>
  <version>%version%</version>
</dependency>
<!-- The module for your preferred lib -->
<dependency>
  <groupId>de.btobastian.sdcf4j</groupId>
  <!-- Possible artifact ids: sdcf4j-javacord, sdcf4j-jda3, sdcf4j-discord4j -->
  <artifactId>sdcf4j-javacord</artifactId>
  <version>%version%</version>
</dependency>

You always need the core module. Depending on your used library you either have to use sdcf4j-javacord, sdcf4j-jda3 or sdcf4j-discord4j. Make sure to replace %version% with the latest version number, e.g. v1.0.0 (don't use this one!).

Latest version: Latest version

Note: If you don't like Maven you can use Gradle, too, or download the .jar files yourself at Jenkins.

JavaDocs

The latest JavaDocs can be found here: JavaDocs

Getting started

Getting Started