discord-rpc-client/README.md

67 lines
2.0 KiB
Markdown
Raw Normal View History

2018-12-05 19:27:39 -05:00
[![Build Status][travis-ci-badge]][travis-ci-page] [![Build status][appveyor-ci-badge]][appveyor-ci-page] [![crates.io][crates-io-badge-ver]][crates-io-page] [![crates.io][crates-io-badge-dl]][crates-io-page] [![Discord][discord-badge]][discord-invite]
2018-03-22 11:03:20 -04:00
# Discord RPC Client
Discord RPC client for Rust
2018-12-05 19:27:39 -05:00
## Installation
Add this to your `Cargo.toml`:
```toml
[dependencies]
2018-04-02 17:44:51 -04:00
discord-rpc-client = "^0.2"
```
2018-12-05 19:27:39 -05:00
## Example
```rust
extern crate discord_rpc_client;
use std::{env, thread, time};
use discord_rpc_client::Client;
fn main() {
// Get our main status message
let state_message = env::args().nth(1).expect("Requires at least one argument");
// Create the client
let mut drpc = Client::new(425407036495495169);
// Start up the client connection, so that we can actually send and receive stuff
drpc.start();
// Set the activity
drpc.set_activity(|act| act.state(state_message))
.expect("Failed to set activity");
// Wait 10 seconds before exiting
thread::sleep(time::Duration::from_secs(10));
}
```
> More examples can be found in the examples directory.
2018-03-22 11:03:20 -04:00
2018-03-23 05:44:52 -04:00
## Contributions
See [CONTRIBUTING.md](CONTRIBUTING.md)
<!-- links -->
2018-03-22 11:03:20 -04:00
[gitlab-ci-badge]: https://gitlab.com/valeth/discord-rpc-client.rs/badges/master/pipeline.svg
[gitlab-repo-master]: https://gitlab.com/valeth/discord-rpc-client.rs/commits/master
2018-12-05 19:27:39 -05:00
[crates-io-badge-ver]: https://img.shields.io/crates/v/discord-rpc-client.svg
[crates-io-badge-dl]: https://img.shields.io/crates/d/discord-rpc-client.svg
2018-03-22 11:08:59 -04:00
[crates-io-page]: https://crates.io/crates/discord-rpc-client
2018-03-22 14:17:07 -04:00
[travis-ci-badge]: https://travis-ci.org/valeth/discord-rpc-client.rs.svg?branch=master
[travis-ci-page]: https://travis-ci.org/valeth/discord-rpc-client.rs
2018-04-02 18:48:57 -04:00
[appveyor-ci-badge]: https://ci.appveyor.com/api/projects/status/3fba86eipx0sgsjp?svg=true
[appveyor-ci-page]: https://ci.appveyor.com/project/valeth/discord-rpc-client-rs
[discord-invite]: https://discordapp.com/invite/zfavwrA
[discord-badge]: https://discordapp.com/api/guilds/200751504175398912/widget.png