Crate discord_game_sdk_sys

Expand description

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.

Structs§

DiscordActivity
DiscordActivityAssets
DiscordActivityParty
DiscordActivitySecrets
DiscordActivityTimestamps
DiscordCreateParams
DiscordEntitlement
DiscordFileStat
DiscordImageDimensions
DiscordImageHandle
DiscordInputMode
DiscordLobby
DiscordOAuth2Token
DiscordPartySize
DiscordPresence
DiscordRelationship
DiscordSku
DiscordSkuPrice
DiscordUser
DiscordUserAchievement
IDiscordAchievementEvents
IDiscordAchievementManager
IDiscordActivityEvents
IDiscordActivityManager
IDiscordApplicationManager
IDiscordCore
IDiscordImageManager
IDiscordLobbyEvents
IDiscordLobbyManager
IDiscordLobbyMemberTransaction
IDiscordLobbySearchQuery
IDiscordLobbyTransaction
IDiscordNetworkEvents
IDiscordNetworkManager
IDiscordOverlayEvents
IDiscordOverlayManager
IDiscordRelationshipEvents
IDiscordRelationshipManager
IDiscordStorageManager
IDiscordStoreEvents
IDiscordStoreManager
IDiscordUserEvents
IDiscordUserManager
IDiscordVoiceEvents
IDiscordVoiceManager

Constants§

DISCORD_ACHIEVEMENT_MANAGER_VERSION
DISCORD_ACTIVITY_MANAGER_VERSION
DISCORD_APPLICATION_MANAGER_VERSION
DISCORD_IMAGE_MANAGER_VERSION
DISCORD_LOBBY_MANAGER_VERSION
DISCORD_NETWORK_MANAGER_VERSION
DISCORD_OVERLAY_MANAGER_VERSION
DISCORD_RELATIONSHIP_MANAGER_VERSION
DISCORD_STORAGE_MANAGER_VERSION
DISCORD_STORE_MANAGER_VERSION
DISCORD_USER_MANAGER_VERSION
DISCORD_VERSION
DISCORD_VOICE_MANAGER_VERSION
DiscordActivityActionType_Join
DiscordActivityActionType_Spectate
DiscordActivityJoinRequestReply_Ignore
DiscordActivityJoinRequestReply_No
DiscordActivityJoinRequestReply_Yes
DiscordActivityType_Listening
DiscordActivityType_Playing
DiscordActivityType_Streaming
DiscordActivityType_Watching
DiscordCreateFlags_Default
DiscordCreateFlags_NoRequireDiscord
DiscordEntitlementType_DeveloperGift
DiscordEntitlementType_FreePurchase
DiscordEntitlementType_PremiumPurchase
DiscordEntitlementType_PremiumSubscription
DiscordEntitlementType_Purchase
DiscordEntitlementType_TestModePurchase
DiscordEntitlementType_UserGift
DiscordImageType_User
DiscordInputModeType_PushToTalk
DiscordInputModeType_VoiceActivity
DiscordLobbySearchCast_Number
DiscordLobbySearchCast_String
DiscordLobbySearchComparison_Equal
DiscordLobbySearchComparison_GreaterThan
DiscordLobbySearchComparison_GreaterThanOrEqual
DiscordLobbySearchComparison_LessThan
DiscordLobbySearchComparison_LessThanOrEqual
DiscordLobbySearchComparison_NotEqual
DiscordLobbySearchDistance_Default
DiscordLobbySearchDistance_Extended
DiscordLobbySearchDistance_Global
DiscordLobbySearchDistance_Local
DiscordLobbyType_Private
DiscordLobbyType_Public
DiscordLogLevel_Debug
DiscordLogLevel_Error
DiscordLogLevel_Info
DiscordLogLevel_Warn
DiscordPremiumType_None
DiscordPremiumType_Tier1
DiscordPremiumType_Tier2
DiscordRelationshipType_Blocked
DiscordRelationshipType_Friend
DiscordRelationshipType_Implicit
DiscordRelationshipType_None
DiscordRelationshipType_PendingIncoming
DiscordRelationshipType_PendingOutgoing
DiscordResult_ApplicationMismatch
DiscordResult_CaptureShortcutAlreadyListening
DiscordResult_Conflict
DiscordResult_GetGuildTimeout
DiscordResult_InsufficientBuffer
DiscordResult_InternalError
DiscordResult_InvalidAccessToken
DiscordResult_InvalidBase64
DiscordResult_InvalidChannel
DiscordResult_InvalidCommand
DiscordResult_InvalidDataUrl
DiscordResult_InvalidEntitlement
DiscordResult_InvalidEvent
DiscordResult_InvalidFileSize
DiscordResult_InvalidFilename
DiscordResult_InvalidGiftCode
DiscordResult_InvalidGuild
DiscordResult_InvalidInvite
DiscordResult_InvalidJoinSecret
DiscordResult_InvalidLobbySecret
DiscordResult_InvalidOrigin
DiscordResult_InvalidPayload
DiscordResult_InvalidPermissions
DiscordResult_InvalidSecret
DiscordResult_InvalidVersion
DiscordResult_LobbyFull
DiscordResult_LockFailed
DiscordResult_NoEligibleActivity
DiscordResult_NotAuthenticated
DiscordResult_NotFetched
DiscordResult_NotFiltered
DiscordResult_NotFound
DiscordResult_NotInstalled
DiscordResult_NotRunning
DiscordResult_OAuth2Error
DiscordResult_Ok
DiscordResult_PurchaseCanceled
DiscordResult_PurchaseError
DiscordResult_RateLimited
DiscordResult_SelectChannelTimeout
DiscordResult_SelectVoiceForceRequired
DiscordResult_ServiceUnavailable
DiscordResult_TransactionAborted
DiscordResult_UnauthorizedForAchievement
DiscordSkuType_Application
DiscordSkuType_Bundle
DiscordSkuType_Consumable
DiscordSkuType_DLC
DiscordStatus_DoNotDisturb
DiscordStatus_Idle
DiscordStatus_Offline
DiscordStatus_Online
DiscordUserFlag_HypeSquadEvents
DiscordUserFlag_HypeSquadHouse1
DiscordUserFlag_HypeSquadHouse2
DiscordUserFlag_HypeSquadHouse3
DiscordUserFlag_Partner

Functions§

DiscordCreate^⚠