#discord #sdk #gamedev

discord_game_sdk

Safe wrapper for the Discord Game SDK

18 releases (1 stable)

✓ Uses Rust 2018 edition

1.0.0 May 3, 2020
1.0.0-rc.4 Mar 30, 2020
1.0.0-rc.3 Feb 17, 2020
0.5.0-alpha.5 Dec 29, 2019
0.1.0 Mar 27, 2019

#27 in Game dev

Download history 84/week @ 2020-03-23 31/week @ 2020-03-30 52/week @ 2020-04-06 70/week @ 2020-04-13 9/week @ 2020-04-20 5/week @ 2020-04-27 10/week @ 2020-05-04 19/week @ 2020-05-11 6/week @ 2020-05-18 27/week @ 2020-05-25 57/week @ 2020-06-01 6/week @ 2020-06-08 19/week @ 2020-06-15 5/week @ 2020-06-22 20/week @ 2020-06-29 20/week @ 2020-07-06

166 downloads per month

Apache-2.0 OR MIT

250KB
4K SLoC

discord_game_sdk

Documentation Latest Version License Build Status

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.37 and up.

Release Notes

Usage

Add this to your Cargo.toml:

[dependencies]
discord_game_sdk = "1.0.0"

Read up on potential bindgen requirements.

Download the Discord Game SDK and set the following environment variable to where you extracted it:

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:

# 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

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:

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.

Communication and Support

I can be reached via Discord twiikuu#0047, on the Official Game SDK Server (nicked as ldesgoui (rust wrapper)), as well as twitter and email. I reserve myself no obligation to support you, although I'm generally nice.

Dependencies

~0.1–1.9MB
~40K SLoC