Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kordlib/kord
Idiomatic Kotlin Wrapper for The Discord API
https://github.com/kordlib/kord
discord discord-api discord-gateway discord-library hacktoberfest kotlin kotlin-coroutines kotlin-js kotlin-jvm kotlin-library
Last synced: about 2 months ago
JSON representation
Idiomatic Kotlin Wrapper for The Discord API
- Host: GitHub
- URL: https://github.com/kordlib/kord
- Owner: kordlib
- License: mit
- Created: 2019-08-17T08:36:48.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T23:12:18.000Z (4 months ago)
- Last Synced: 2024-05-22T13:52:35.039Z (4 months ago)
- Topics: discord, discord-api, discord-gateway, discord-library, hacktoberfest, kotlin, kotlin-coroutines, kotlin-js, kotlin-jvm, kotlin-library
- Language: Kotlin
- Homepage:
- Size: 304 MB
- Stars: 823
- Watchers: 10
- Forks: 77
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- discord-api-libs - kord - Idiomatic Kotlin Wrapper for The Discord API (Libraries / Kotlin)
- awesome-discord - Kord
README
# Kord
[](https://discord.gg/6jcx5ev)
[](https://central.sonatype.com/artifact/dev.kord/kord-core)
[]()
Kord is a [coroutine-based](https://kotlinlang.org/docs/reference/coroutines-overview.html), modularized implementation
of the Discord API, written 100% in [Kotlin](https://kotlinlang.org/).
If you have any feedback, we'd love to hear it, hit us up on discord or write up an issue if you have any suggestions!
## Why use Kord
Kord was created as an answer to the frustrations of writing Discord bots with other JVM libraries, which either use
thread-blocking code or verbose and scope restrictive reactive systems. We believe an API written from the ground up in
Kotlin with coroutines can give you the best of both worlds: The conciseness of imperative code with the concurrency of
reactive code.
Aside from coroutines, we also wanted to give the user full access to lower level APIs. Sometimes you have to do some
unconventional things, and we want to allow you to do those in a safe and supported way.
## Status of Kord
* [X] [Discord Gateway](gateway)
* [x] [Discord Rest API](rest)
* [X] [High level abstraction + caching](core)
* [X] [Discord Voice](voice)
* [ ] Support for multiple processes [#7](https://github.com/kordlib/kord/issues/7)
Right now, Kord *should* provide a full mapping of the non-voice API on Kotlin/JVM and Kotlin/JS and an experimental
mapping of the Voice API on Kotlin/JVM
## Documentation
* [Dokka docs](https://kordlib.github.io/kord/)
* [Wiki](https://github.com/kordlib/kord/wiki)
## Modules
| Module | Docs | Artifact | JVM | JS | Native² |
|--------------------------|---------------------------------------------------------|-------------------|-----|----|---------|
| [common](common) | [common](https://kordlib.github.io/kord/common) | `kord-common`¹ | ✅ | ✅ | ❌ |
| [rest](rest) | [rest](https://kordlib.github.io/kord/rest) | `kord-rest`¹ | ✅ | ✅ | ❌ |
| [gateway](gateway) | [gateway](https://kordlib.github.io/kord/gateway) | `kord-gateway`¹ | ✅ | ✅ | ❌ |
| [core](core) | [core](https://kordlib.github.io/kord/core) | `kord-core`¹ | ✅ | ✅ | ❌ |
| [voice](voice) | [voice](https://kordlib.github.io/kord/voice) | `kord-voice` | ✅ | ❌³ | ❌ |
| [core-voice](core-voice) | [core-voice](https://kordlib.github.io/kord/core-voice) | `kord-core-voice` | ✅ | ❌ | ❌ |
¹ These artifacts only supports Gradle Version 5.3 or higher, for older Gradle versions and Maven please append `-jvm`
² For Native Support please see #69
³ For Voice JS please see #69
## Installation
Replace `{version}` with the latest version number on maven central.
For Snapshots replace `{version}` with `{branch}-SNAPSHOT`
e.g: `feature-amazing-thing-SNAPSHOT` for the branch `feature/amazing-thing`
For Snapshots for the branch `main` replace `{version}` with `{nextPlannedVersion}-SNAPSHOT` (see `nextPlannedVersion`
in [`gradle.properties`](gradle.properties))
[](https://central.sonatype.com/artifact/dev.kord/kord-core)
### Gradle (Kotlin)
```kotlin
repositories {
mavenCentral()
// Kord Snapshots Repository (Optional):
maven("https://oss.sonatype.org/content/repositories/snapshots")
}
dependencies {
implementation("dev.kord:kord-core:{version}")
}
```
### Gradle (Groovy)
```groovy
repositories {
mavenCentral()
// Kord Snapshots Repository (Optional):
maven {
url "https://oss.sonatype.org/content/repositories/snapshots"
}
}
dependencies {
implementation("dev.kord:kord-core:{version}")
}
```
### Maven
##### Kord Snapshots Repository (Optional):
```xml
snapshots-repo
https://oss.sonatype.org/content/repositories/snapshots
false
true
```
---
```xml
dev.kord
kord-core-jvm
{version}
```
## FAQ
## Will you support kotlin multi-platform
Currently we're supporting both Kotlin/JVM and Kotlin/JS for the majority of our API, for more information check
[Modules](#modules) and #69
## When will you document your code?
Yes.
# This project is supported by JetBrains
[](https://jb.gg/OpenSourceSupport)