discord_game_sdk_sys

Crates.iodiscord_game_sdk_sys
lib.rsdiscord_game_sdk_sys
version1.0.1
sourcesrc
created_at2019-03-27 15:04:36.051413
updated_at2021-08-01 20:15:23.834018
descriptionLow-level bindings for the Discord Game SDK
homepage
repositoryhttps://github.com/ldesgoui/discord_game_sdk
max_upload_size
id124175
size46,573
Lucas Desgouilles (ldesgoui)

documentation

README

discord_game_sdk_sys

Documentation Latest Version License

This crate provides bindgen-generated bindings to the Discord Game SDK.

This crate is not official, it is not supported by the Discord Game SDK Developers.

Following the -sys package conventions, this crate does not define higher-level abstractions.

Usage

Add this to your Cargo.toml:

[dependencies]
discord_game_sdk_sys = "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:

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 search)
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.

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.

Commit count: 51

cargo fmt