Skip to content

document nameplates #7506

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

document nameplates #7506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8849b2
document nameplates
Lexedia Apr 23, 2025
3df293b
newline :(
Lexedia Apr 23, 2025
221c2d9
fix reference links
Lexedia Apr 23, 2025
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
1 change: 1 addition & 0 deletions docs/reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
| Role Icon | role-icons/[role_id](/docs/topics/permissions#role-object)/[role_icon](/docs/topics/permissions#role-object).png | PNG, JPEG, WebP |
| Guild Scheduled Event Cover | guild-events/[scheduled_event_id](/docs/resources/guild-scheduled-event#guild-scheduled-event-object)/[scheduled_event_cover_image](/docs/resources/guild-scheduled-event#guild-scheduled-event-object).png | PNG, JPEG, WebP |
| Guild Member Banner | guilds/[guild_id](/docs/resources/guild#guild-object)/users/[user_id](/docs/resources/user#user-object)/banners/[member_banner](/docs/resources/guild#guild-member-object).png \* | PNG, JPEG, WebP, GIF |
| Nameplate Asset | assets/collectibles/[asset](/docs/resources/user#nameplate-nameplate-structure)/asset.webm | WebM |

\* In the case of endpoints that support GIFs, the hash will begin with `a_` if it is available in GIF format. (example: `a_1269e74af4df7417b13759eae50c83dc`)

Expand Down
26 changes: 26 additions & 0 deletions docs/resources/user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ There are other rules and restrictions not shared here for the sake of spam and
| premium_type? | integer | the [type of Nitro subscription](/docs/resources/user#user-object-premium-types) on a user's account | identify |
| public_flags? | integer | the public [flags](/docs/resources/user#user-object-user-flags) on a user's account | identify |
| avatar_decoration_data? | ?[avatar decoration data](/docs/resources/user#avatar-decoration-data-object) object | data for the user's avatar decoration | identify |
| collectibles? | ?[collectibles](/docs/resources/user#collectibles) object | data for the user's collectibles | identify

###### Example User

Expand Down Expand Up @@ -183,6 +184,31 @@ The role connection object that an application has attached to a user.
| platform_username | ?string | the username on the platform a bot has connected (max 100 characters) |
| metadata | object | object mapping [application role connection metadata](/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object) keys to their `string`-ified value (max 100 characters) for the user on the platform a bot has connected |

### Collectibles

The collectibles the user has.

###### Collectible Structure

| Field | Type | Description |
|------------|--------|------------------------------------------------------------------------------|
| nameplate? | object | object mapping of [nameplate data](/docs/resources/user#nameplate-nameplate-structure) |


### Nameplate

The nameplate the user currently has.

###### Nameplate Structure

| Field | Type | Description |
|---------|-----------|-----------------------------------------------------------------|
| sku_id | snowflake | id of the nameplate's decoration SKU |
| asset | string | path to the [nameplate asset](/docs/reference#image-formatting) |
| label | string | the label of this nameplate |
| palette | string | the name of the most dominant colour in this nameplate |


## Get Current User
<Route method="GET">/users/@me</Route>

Expand Down