Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ldesgoui/discord_game_sdk
Rust bindings for the Discord Game SDK
https://github.com/ldesgoui/discord_game_sdk
Last synced: 10 days ago
JSON representation
Rust bindings for the Discord Game SDK
- Host: GitHub
- URL: https://github.com/ldesgoui/discord_game_sdk
- Owner: ldesgoui
- License: apache-2.0
- Created: 2019-03-24T17:51:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T20:14:52.000Z (over 3 years ago)
- Last Synced: 2024-10-06T11:47:21.513Z (about 1 month ago)
- Language: Rust
- Homepage: https://docs.rs/discord_game_sdk
- Size: 618 KB
- Stars: 61
- Watchers: 4
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE-2.0
Awesome Lists containing this project
- awesome-discord - discord_game_sdk - Rust bindings for the Discord Game SDK. (Game SDK & RPC Bindings)
README
# discord_game_sdk
[](https://docs.rs/discord_game_sdk)
[](https://crates.io/crates/discord_game_sdk)
[](https://github.com/ldesgoui/discord_game_sdk/actions)
This crate provides a safe interface to the [Discord Game SDK].
*This crate is not official, it is not supported by the Discord Game SDK Developers.*
The [Discord Game SDK] provides features such as, but not limited to:
- Activities (Rich Presence)
- Users, Avatars and Relationships
- Lobbies, Matchmaking and Voice communication
- Faux-P2P Networking on Discord's Infrastructure
- Cloud Synchronized Storage
- Store Transactions
- Achievements
*Version requirement: Rust 1.47 and up.*
*[Release Notes](https://github.com/ldesgoui/discord_game_sdk/releases)*
## Usage
Add this to your `Cargo.toml`:
```toml
[dependencies]
discord_game_sdk = "1.0.1"
```
Read up on potential [`bindgen` requirements].
Download the [Discord Game SDK] and set the following environment variable to where you extracted it:
```sh
export DISCORD_GAME_SDK_PATH=/path/to/discord_game_sdk
```
If you're also planning on using the default `link` feature, keep reading below.
## Features:
#### `link`
Enabled by default, delegates to `discord_game_sdk_sys/link`.
Provides functional linking with the caveat that libraries are renamed and some additional
set-up is required:
```sh
# Linux: prepend with `lib` and add to library search path
cp $DISCORD_GAME_SDK_PATH/lib/x86_64/{,lib}discord_game_sdk.so
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}$DISCORD_GAME_SDK_PATH/lib/x86_64
# Mac OS: prepend with `lib` and add to library search path
cp $DISCORD_GAME_SDK_PATH/lib/x86_64/{,lib}discord_game_sdk.dylib
export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH:+${DYLD_LIBRARY_PATH}:}$DISCORD_GAME_SDK_PATH/lib/x86_64
# Windows: change `dll.lib` to `lib` (won't affect library searching)
cp $DISCORD_GAME_SDK_PATH/lib/x86_64/discord_game_sdk.{dll.lib,lib}
cp $DISCORD_GAME_SDK_PATH/lib/x86/discord_game_sdk.{dll.lib,lib}
```
This allows for `cargo run` to function.
#### [`image`](https://docs.rs/image)
Optional crate.
Provides a conversion from our `Image` to `image::RgbaImage`.
## Safety
This crate relies on the SDK to provide correct data and behavior:
- Non-null pointers to valid memory
- UTF-8, NUL-terminated strings
- No mutation of memory it should have no ownership of
- No use of pointers after `destroy` is called
Some of these are tested when compiled with `debug_assertions`.
## Legal
You *MUST* acquaint yourself with and agree to the [official terms of the Discord Game SDK].
The code of the Rust crates `discord_game_sdk` and `discord_game_sdk_sys`
are licensed at your option under either of:
* [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
* [MIT License](https://opensource.org/licenses/MIT)
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.
[Discord Game SDK]: https://discordapp.com/developers/docs/game-sdk/sdk-starter-guide
[`bindgen` requirements]: https://rust-lang.github.io/rust-bindgen/requirements.html
[official terms of the Discord Game SDK]: https://discordapp.com/developers/docs/legal