Skip to content

Latest commit

 

History

History
120 lines (94 loc) · 3.53 KB

README.md

File metadata and controls

120 lines (94 loc) · 3.53 KB
Raw

Disko

A Discord API wrapper built for Kotlin/JVM developers. Building towards a beautiful, clean and fully featured wrapping of Discord's REST and Gateway APIs, allowing you to create Discord Bots and Applications with ease in Kotlin/JVM.

Support

Table of Contents

  1. Setup
  2. Basic Usage
  3. Contributing
  4. A Note on Sharding
  5. A Note on Self-Bots
  6. Related Projects

Setup

For now, you cannot use Disko in actual environments. It is an early ALPHA state.
To use Disko in your project, add the following to your relevant build file:

Gradle 
repositories {
    maven { url = "https://maven.deftu.dev/releases" }
}

dependencies {
    implementation("dev.deftu:disko:<VERSION>")
}
Kotlin DSL 
repositories {
    maven("https://maven.deftu.dev/releases")
}

dependencies {
    implementation("dev.deftu:disko:<VERSION>")
}
Maven 
<repositories>
    <repository>
        <id>deftu-repo</id>
        <url>https://maven.deftu.dev/releases</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>dev.deftu</groupId>
        <artifactId>disko</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>

Basic Usage

import dev.deftu.disko.Disko

fun main() {
    val disko = Disko {
        intents {
            +GatewayIntent.MESSAGE_CONTENT
        }
        
        presence {
            status = OnlineStatus.DND
            +playing("with Disko")
        }
    }
    
    disko.login("YOUR_BOT_TOKEN")
    
    disko.eventBus.on<MessageCreateEvent> { event ->
        if (event.message.content == "!ping") {
            event.message.reply {
                content = "Pong!"
            }
        }
    }
}

Contributing

If you would like to contribute to Disko, please base your branch on main (or, a specific feature branch) and open a pull request into the same branch, providing as many relevant details as possible in the description. If you are unsure about something, feel free to ask in the pull request or in the Discord server.

A Note on Sharding

Disko will automatically manage sharding for you, so you don't have to worry about it. Manually sharding is not supported as of yet, but will be in the future. If you would like to contribute towards how manual sharding will function, please connect with us in our Discord server so we can discuss further.

A Note on Self-Bots

Self-bots are not supported by Disko, and will not be supported in the future. Discord has expressed their prohibition of self-bots in their Terms of Service, and we will not be supporting any actions that go against their terms. You will need to create a bot account from the Discord Developer Portal to use Disko.

Related Projects