Skip to main content

Discord Game Status Information (DiscordRichPresence)

Data Structure

INTLDiscordRichPresence

ParametersTypeExplanationNote
GameNameStringGame name registered on Discord Developer PortalMandatory
StatestringThe party status of the activity,
if specified, it must be a string between 2 to 128 characters
Optional
DetailsstringDetailed description, defaults to empty value,
if specified, it must be a string between 2 to 128 characters
Optional
LargeTextStringText prompt for large image,
if specified, it must be a string between 2 to 128 characters
Optional
LargeImagestringLink for large image,
if specified, it must be a string between 1 to 256 characters
Optional
SmallTextstringText prompt for small image,
if specified, it must be a string between 2 to 128 characters
Optional
SmallImagestringLink for small image,
if specified, it must be a string between 1 to 256 characters
Optional
StartTimelongTimestamp for starting this activity
'start_time_' and 'end_time_' should be both set or neither.
If neither is set, the game defaults to start at 00:00:00.
If both are set, 'start_time_' will be used.
Optional
EndTimelongTimestamp when this activity endsOptional
PartyMaxSizeintThe maximum number of people who can join the party, default is 0, the set value must be greater than or equal to 0Optional
SupportedPlatformsintOn which platforms activity invitations can be accepted.
PC = 1, IOS = 8, Android = 16.
Supports using values like 1 | 8 | 16 to support multiple platforms
Optional
ExtraJsonStringExtended JSON field, default is an empty stringOptional

Example of displaying player game status on Discord client can refer to the image below: Image: Game Status Example