vyfor / kpresence

📦 A lightweight, cross-platform Kotlin library for Discord Rich Presence interaction.

🧩 KPresence

📦 A lightweight, cross-platform Kotlin Multiplatform library for interacting with Discord Rich Presence.

💎 Features

• Cross-platform compatibility (Windows, Linux, macOS)
• Fast and user-friendly
• Offers DSL support
• Provides both JVM and Native implementations
• Validates the activity fields before sending them
• Supports Flatpak and Snap installations on Linux

🔌 Requirements

• Java: 16 or later (only for use within the JVM environment)

⚙️ Installation

dependencies {
    implementation("io.github.vyfor:kpresence:0.6.2")
}

✨ Examples

Initial connection and presence updates

val client = RichClient(CLIENT_ID)
  
client.connect()

client.update {
    type = ActivityType.GAME
    details = "Exploring Kotlin Native"
    state = "Writing code"
    
    timestamps {
        start = now() - 3600_000
        end = now() + 3600_000
    }
    
    party {
      id = "myParty"
      size(current = 1, max = 5)
    }
    
    assets {
        largeImage = "kotlin_logo"
        largeText = "Kotlin"
        smallImage = "jetbrains_logo"
        smallText = "JetBrains"
    }
    
    secrets {
        join = "joinSecret"
        spectate = "spectateSecret"
        match = "matchSecret"
    }
    
    button("Learn more", "https://kotlinlang.org/")
    button("Try it yourself", "https://play.kotlinlang.org/")
}

Event handling

val client = RichClient(CLIENT_ID)

client.on<ReadyEvent> {
  update(activity)
}

client.on<ActivityUpdateEvent> {
  logger?.info("Updated rich presence")
}

client.on<DisconnectEvent> {
  connect(shouldBlock = true) // Attempt to reconnect
}

client.connect(shouldBlock = false)

Logging

val client = RichClient(CLIENT_ID)
client.logger = ILogger.default()

kpresence's Issues

Fix error handling for unexpected Discord closures

Better error handling

Kotlin/JVM support

Provide support for Kotlin/JVM.

Create a buffer dynamically for read operations

Discord includes the data length along with the payload, which we can use to create a buffer dynamically, rather than relying on a fixed buffer size.

Switch to event-driven approach

Add logging

Add support for Flatpak and Snap installations

Linux support

ConnectionException on Fedora 39

ConnectionException is thrown when connecting on Fedora 39. This seems to persist even when Discord client is closed.

Reproducible example

fun main() {
    val client = RichClient(/* id */)
    client.connect()
}

Stacktrace

Exception in thread "main" io.github.vyfor.kpresence.exception.ConnectionException
	at io.github.vyfor.kpresence.ipc.Connection$UnixConnection.open(Connection.kt:135)
	at io.github.vyfor.kpresence.ipc.Connection.open(Connection.kt:24)
	at io.github.vyfor.kpresence.RichClient.connect(RichClient.kt:53)
	at io.github.vyfor.kpresence.RichClient.connect$default(RichClient.kt:47)
	at io.github.pandier.MainKt.main(Main.kt:7)
	at io.github.pandier.MainKt.main(Main.kt)

Stacktrace of exception inside ConnectionException:

java.net.SocketException: No such file or directory
	at java.base/sun.nio.ch.UnixDomainSockets.connect0(Native Method)
	at java.base/sun.nio.ch.UnixDomainSockets.connect(UnixDomainSockets.java:148)
	at java.base/sun.nio.ch.UnixDomainSockets.connect(UnixDomainSockets.java:144)
	at java.base/sun.nio.ch.SocketChannelImpl.connect(SocketChannelImpl.java:851)
	at java.base/java.nio.channels.SocketChannel.open(SocketChannel.java:285)
	at io.github.vyfor.kpresence.ipc.Connection$UnixConnection.open(Connection.kt:130)
	at io.github.vyfor.kpresence.ipc.Connection.open(Connection.kt:24)
	at io.github.vyfor.kpresence.RichClient.connect(RichClient.kt:53)
	at io.github.vyfor.kpresence.RichClient.connect$default(RichClient.kt:47)
	at io.github.pandier.MainKt.main(Main.kt:9)
	at io.github.pandier.MainKt.main(Main.kt)

Environment

• KPresence version: 0.6.0
• OS: Fedora 39

Rewrite code for Windows target

Current implementation makes use of posix libraries to display rich presence. It is preferred to use the Windows API for better compatibility.

Setup cross-compilation using GitHub Actions