https://github.com/SpaceManiac/discord-rs

Rust library for the Discord chat client API
https://github.com/SpaceManiac/discord-rs

discord voice

Last synced: 3 months ago
JSON representation

Rust library for the Discord chat client API

• Host: GitHub
• URL: https://github.com/SpaceManiac/discord-rs
• Owner: SpaceManiac
• License: mit
• Created: 2015-11-27T09:47:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-22T02:03:15.000Z (7 months ago)
• Last Synced: 2024-03-17T07:05:38.128Z (3 months ago)
• Topics: discord, voice
• Language: Rust
• Size: 880 KB
• Stars: 380
• Watchers: 17
• Forks: 93
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• my-awesome-stars - SpaceManiac/discord-rs - Rust library for the Discord chat client API (Rust)
• awesome-stars - discord-rs
• discord-api-libs - discord-rs - Rust library for the Discord chat client API (Libraries / Rust)

README

        
discord-rs [![](https://meritbadge.herokuapp.com/discord)](https://crates.io/crates/discord) [![](https://img.shields.io/badge/docs-online-2020ff.svg)](https://docs.rs/discord)

==========

> This project is only maintained occasionally. If you're having problems, open

> a pull request or check the [network graph] for up-to-date forks.

[network graph]: https://github.com/SpaceManiac/discord-rs/network

**discord-rs** is a [Rust](https://www.rust-lang.org) client library for the

[Discord](https://discord.com) chat client's API.

The Discord API can be divided into three main components: the RESTful API

to which calls can be made to take actions, a websocket-based permanent

connection over which state updates are received, and the voice calling

system.

Log in to Discord with `Discord::new`, `new_cache`, or `from_bot_token` as

appropriate. The resulting value can be used to make REST API calls to post

messages and manipulate Discord state. Calling `connect()` will open a

websocket connection, through which events can be received. These two channels

are enough to write a simple chatbot which can read and respond to messages.

For more in-depth tracking of Discord state, a `State` can be seeded with

the `ReadyEvent` obtained when opening a `Connection` and kept updated with

the events received over it.

To join voice servers, call `Connection::voice` to get a `VoiceConnection`

and use `connect` to join a channel, then `play` and `stop` to control

playback. Manipulating deaf/mute state and receiving audio are also possible.

For further details, browse the [source](src/) or read

[the documentation](https://docs.rs/discord).

For examples, browse the [examples](examples/) directory.

## Installation

On Windows, discord-rs currently requires a GNU-like environment. For details,

read the [installation guide](https://github.com/SpaceManiac/discord-rs/wiki/Windows-Installation).

On all platforms, discord-rs has several system dependencies, which should be

installed as appropriate:

* `pkg-config`

* `openssl`

* `libsodium` (if using voice)

* `opus` (if using voice)

* `ffmpeg` (if using ffmpeg features)

* `youtube-dl` (if using youtube-dl features)