ky28059 / diskord

[Mirror of GitLab] A Kotlin client for Discord with a light wrapper on the REST APIs and a simple to use DSL for basic bots.

Diskord

A Kotlin client for Discord bots with a simple and concise DSL

Built as a lean client using coroutines that gets the intricacies of rate limits, async, and data models out of your way in a clean and easy to use SDK.

Feel free to submit a PR or an Issue and I'll address it ASAP.

Using Diskord? Send me a tweet about it @JesseLCorbett or drop by the Discord server.

How do I import this?

Gradle

repositories {
    mavenCentral()
    jcenter()
}

dependencies {
    // Only if gradle >= 5.3
    implementation 'com.jessecorbett:diskord:1.8.1'

    // Valid for all gradle versions
    implementation 'com.jessecorbett:diskord-jvm:1.8.1'
}

Maven

<dependency>
    <groupId>com.jessecorbett</groupId>
    <artifactId>diskord-jvm</artifactId>
    <version>1.8.1</version>
</dependency>

How do I use this?

Simply instantiate a bot using the bot DSL, such as in the examples below.

Any function in the scope of the DSL will have access to a ClientStore clientStore to access clients for the bot user.

Additionally, extensions on the bot DSL, like the command DSL, can be done simply by writing extension functions which hook into the bot DSL on instantiation.

You can find more examples here.

You can access the documentation here.

Ping Pong Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN) {
        commands {
            command("ping") {
                reply("pong")
                delete()
            }
        }
    }
}

Echo Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN) {
        commands {
            command("echo") {
                reply(words.drop(1).joinToString(" "))
                delete()
            }
        }
    }
}

Embed Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN) {
        // Defaults to using command prefix `.` if unspecified
        commands("!") {
            command("embed") {
                delete()
                reply {
                    text = "This is an embed"
                    title = "Embed title"
                    description = "You can declare all the things here"
                }
            }
        }
    }
}

Reaction Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN) {
        messageCreated {
            if (it.content.contains("diskord")) {
                it.react("💯")
            }
        }
    }
}

Combined Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN) {
        messageCreated {
            if (it.content.contains("diskord")) {
                it.react("💯")
            }
        }
        
        // Defaults to using command prefix `.`
        commands {
            command("ping") {
                reply("pong")
                delete()
            }
                
            command("echo") {
                reply(words.drop(1).joinToString(" "))
                delete()
            }            
        }
    }
}

Intents Example

const val BOT_TOKEN = "A-Totally-Real-Discord-Bot-Token"

suspend fun main() {
    bot(BOT_TOKEN, intents = GatewayIntents.ALL) {
        userPresenceUpdated {
            // Presence data is considered "privileged" and not enabled by default.
            //
            // See [https://discord.com/developers/docs/topics/gateway#gateway-intents] for more information.
        }
    }
}

FAQ

• Does this support voice chat?
  • No, voice chat is not supported at this time. If you need it I recommend checking out JDA or Discord4J
• Is this library done?
  • It still needs some tests written, but Diskord is actively maintained and API complete, so it should be safe to use
• Can I contact you to ask a question/contribute to the project/report a bug/tell you this is all shit?
  • Go for it!
• What if I'm hip and cool, and I want to use a newer more unstable exciting version?
  • You can use our development versions by using the snapshot repository
    • Repository URL https://oss.sonatype.org/content/repositories/snapshots/
    • Artifact directory https://gitlab.com/jesselcorbett/diskord/-/packages

Things to do

• Add more testing
• Voice support