filthy-rich

Tiny, ergonomic Discord Rich Presence library for your Rust apps.

// a sneak-peek into what you'll be working with
// this usually helps me personally when looking at libraries

#[tokio::main]
async fn main() -> Result<()> {
    let mut client = DiscordIPC::new("1463450870480900160")
        .on_ready(|data| println!("Connected to: {}", data.user.username));

    client.run(true).await?;

    let activity = Activity::new()
        .details("Playing a game")
        .state("In menu")
        .large_image("game_icon", Some("My Game"))
        .small_image("status", Some("Online"))
        .build();

    client.set_activity(activity).await?;
    client.wait().await?;

    Ok(())
}

[!WARNING] All development work happens in the Codeberg repository; this GitHub mirror is primarily for receiving pull requests from the broader spectrum of the userbase.

[!NOTE] Requires Rust 1.82.0 or later.

Add filthy-rich to your project with this command:

cargo add filthy-rich

🌺 Features

• Really easy to implement; just create a client ID at the Discord Developer Portal and you're good to go.
• Fruitful Activity builder guaranteed to make you fall in love with setting presences.
• Support for rich presence assets (large and small images with hover text).
• Clean whilst being easy; properly handles Discord's responses.
• Fully asynchronous, but can be easily wrapped upon for synchronous compatibility.
• Auto-reconnect on failure.

Starter Snippets

Examples are included with the project. See these:

1. For an indefinitely running rich presence, see this.
2. For an timed, changing rich presence, see this.

To run these:

# First, clone and `cd` into the repository.
git clone https://github.com/hitblast/filthy-rich && cd filthy-rich

# Now, run any of the examples:
cargo run --example indefinite  # ex. 1
cargo run --example timed  # ex. 2

API Reference (docs.rs)

https://docs.rs/crate/filthy-rich/latest

Yet another library?

I don't want to bother myself with manually implementing Rich Presence everytime I start working on an app, so I created this library to make things much simpler; I just want a client that does its job in the background.

Also, other implementations felt much more complex to me and also felt like they lacked precise control. This is a more "spread-out" opinion and might hide the truth for some libraries, but yeah, nothing better than throwing your own luck into making yet another IPC client.

Contributors

Thanks to the amazing contributors for adding to this repository:

• Sirokovsk

License

Licensed under MIT.