filthy-rich 0.8.2

Tiny, ergonomic Discord Rich Presence library for your Rust apps.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

<div align="center">

<img src="./assets/art.png" width="120px" align="center">

# <img src="https://github.com/github/explore/blob/main/topics/rust/rust.png?raw=true" width="40px"> filthy-rich

**Tiny, ergonomic Discord Rich Presence library for your Rust apps.**<br>

![Crates.io MSRV](https://img.shields.io/crates/msrv/filthy-rich)
![Crates.io Size](https://img.shields.io/crates/size/filthy-rich)
![Crates.io License](https://img.shields.io/crates/l/filthy-rich)

</div>

```rust
// 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](https://codeberg.org/hitblast/filthy-rich); 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:

```bash
cargo add filthy-rich
```

## 🌺 Features

- Really easy to implement; just create a client ID at the [Discord Developer Portal](https://discord.com/developers) 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](./examples/indefinite.rs).
2. For an timed, changing rich presence, [see this](./examples/timed.rs).

To run these:

```bash
# 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](https://github.com/Sirokovsk)

## License

Licensed under [MIT](./LICENSE).