Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom status to activity docs #1162

Merged
merged 5 commits into from
Nov 8, 2019
Merged

Add custom status to activity docs #1162

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f92229b
Add custom status to activity docs
MinnDevelopment Oct 26, 2019
8c70711
Update docs/topics/Gateway.md
MinnDevelopment Oct 26, 2019
cb787b9
Update state description
MinnDevelopment Oct 30, 2019
0b56f65
Merge branch 'patch-custom-status' of github.com:MinnDevelopment/disc…
MinnDevelopment Oct 30, 2019
02cafcc
Update docs/topics/Gateway.md
MinnDevelopment Oct 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/topics/Gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -799,7 +799,8 @@ Active sessions are indicated with an "online", "idle", or "dnd" string per plat
| timestamps? | [timestamps](#DOCS_TOPICS_GATEWAY/activity-object-activity-timestamps) object | unix timestamps for start and/or end of the game |
| application_id? | snowflake | application id for the game |
| details? | ?string | what the player is currently doing |
| state? | ?string | the user's current party status |
| state? | ?string | the user's current party status or custom status text |
| emoji? | ?[emoji]#DOCS_TOPIC_GATEWAY/activity-object-activity-emoji) object | the emoji used for a custom status |
| party? | [party](#DOCS_TOPICS_GATEWAY/activity-object-activity-party) object | information for the current party of the player |
| assets? | [assets](#DOCS_TOPICS_GATEWAY/activity-object-activity-assets) object | images for the presence and their hover texts |
| secrets? | [secrets](#DOCS_TOPICS_GATEWAY/activity-object-activity-secrets) object | secrets for Rich Presence joining and spectating |
Expand All @@ -816,6 +817,7 @@ Active sessions are indicated with an "online", "idle", or "dnd" string per plat
| 0 | Game | Playing {name} | "Playing Rocket League" |
| 1 | Streaming | Streaming {name} | "Streaming Rocket League" |
| 2 | Listening | Listening to {name} | "Listening to Spotify" |
| 4 | Custom | {emoji} {state} | ":smiley: I am cool" |

> info
> The streaming type currently only supports Twitch. Only `https://twitch.tv/` urls will work.
Expand All @@ -827,6 +829,14 @@ Active sessions are indicated with an "online", "idle", or "dnd" string per plat
| start? | int | unix time (in milliseconds) of when the activity started |
| end? | int | unix time (in milliseconds) of when the activity ends |

###### Activity Emoji

| Field | Type | Descirption |
| --------- | --------- | ------------------------------ |
| name | string | the name of the emoji |
| id? | snowflake | the id of the emoji |
| animated? | boolean | whether this emoji is animated |

###### Activity Party

| Field | Type | Description |
Expand Down