Skip to content

Commit

Permalink
Document avatar decorations (discord#5723)
Browse files Browse the repository at this point in the history 
Co-authored-by: shay <[email protected]>
  • Loading branch information
@advaith1 @shaydewael
advaith1 and shaydewael committed May 14, 2024
1 parent 3366926 commit 94fd286
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
3 changes: 2 additions & 1 deletion docs/Reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,10 @@ Discord uses ids and hashes to render images in the client. These hashes can be
| Default User Avatar | embed/avatars/[index](#DOCS_RESOURCES_USER/user-object).png \*\* \*\*\* | PNG |
| User Avatar | avatars/[user_id](#DOCS_RESOURCES_USER/user-object)/[user_avatar](#DOCS_RESOURCES_USER/user-object).png \* | PNG, JPEG, WebP, GIF |
| Guild Member Avatar | guilds/[guild_id](#DOCS_RESOURCES_GUILD/guild-object)/users/[user_id](#DOCS_RESOURCES_USER/user-object)/avatars/[member_avatar](#DOCS_RESOURCES_GUILD/guild-member-object).png \* | PNG, JPEG, WebP, GIF |
| User Avatar Decoration | avatar-decorations/[user_id](#DOCS_RESOURCES_USER/user-object)/[user_avatar_decoration](#DOCS_RESOURCES_USER/user-object).png | PNG |
| Application Icon | app-icons/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[icon](#DOCS_RESOURCES_APPLICATION/application-object).png | PNG, JPEG, WebP |
| Application Cover | app-icons/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[cover_image](#DOCS_RESOURCES_APPLICATION/application-object).png | PNG, JPEG, WebP |
| Application Asset | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[asset_id](#DOCS_TOPICS_GATEWAY_EVENTS/activity-object-activity-assets).png | PNG, JPEG, WebP |
| Application Asset | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[asset_id](#DOCS_TOPICS_GATEWAY_EVENTS/activity-object-activity-assets).png | PNG, JPEG, WebP |
| Achievement Icon | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/achievements/[achievement_id](#DOCS_GAME_SDK_ACHIEVEMENTS/data-models-user-achievement-struct)/icons/[icon_hash](#DOCS_GAME_SDK_ACHIEVEMENTS/data-models-user-achievement-struct).png | PNG, JPEG, WebP |
| Store Page Asset | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/store/asset_id | PNG, JPEG, WebP |
| Sticker Pack Banner | app-assets/710982414301790216/store/[sticker_pack_banner_asset_id](#DOCS_RESOURCES_STICKER/sticker-pack-object).png | PNG, JPEG, WebP |
Expand Down
37 changes: 19 additions & 18 deletions docs/resources/User.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,25 @@ There are other rules and restrictions not shared here for the sake of spam and

###### User Structure

| Field | Type | Description | Required OAuth2 Scope |
| ------------- | --------- | ---------------------------------------------------------------------------------------------------- | --------------------- |
| id | snowflake | the user's id | identify |
| username | string | the user's username, not unique across the platform | identify |
| discriminator | string | the user's Discord-tag | identify |
| global_name | ?string | the user's display name, if it is set. For bots, this is the application name | identify |
| avatar | ?string | the user's [avatar hash](#DOCS_REFERENCE/image-formatting) | identify |
| bot? | boolean | whether the user belongs to an OAuth2 application | identify |
| system? | boolean | whether the user is an Official Discord System user (part of the urgent message system) | identify |
| mfa_enabled? | boolean | whether the user has two factor enabled on their account | identify |
| banner? | ?string | the user's [banner hash](#DOCS_REFERENCE/image-formatting) | identify |
| accent_color? | ?integer | the user's banner color encoded as an integer representation of hexadecimal color code | identify |
| locale? | string | the user's chosen [language option](#DOCS_REFERENCE/locales) | identify |
| verified? | boolean | whether the email on this account has been verified | email |
| email? | ?string | the user's email | email |
| flags? | integer | the [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account | identify |
| 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 |
| Field | Type | Description | Required OAuth2 Scope |
| ------------------ | --------- | ---------------------------------------------------------------------------------------------------- | --------------------- |
| id | snowflake | the user's id | identify |
| username | string | the user's username, not unique across the platform | identify |
| discriminator | string | the user's Discord-tag | identify |
| global_name | ?string | the user's display name, if it is set. For bots, this is the application name | identify |
| avatar | ?string | the user's [avatar hash](#DOCS_REFERENCE/image-formatting) | identify |
| bot? | boolean | whether the user belongs to an OAuth2 application | identify |
| system? | boolean | whether the user is an Official Discord System user (part of the urgent message system) | identify |
| mfa_enabled? | boolean | whether the user has two factor enabled on their account | identify |
| banner? | ?string | the user's [banner hash](#DOCS_REFERENCE/image-formatting) | identify |
| accent_color? | ?integer | the user's banner color encoded as an integer representation of hexadecimal color code | identify |
| locale? | string | the user's chosen [language option](#DOCS_REFERENCE/locales) | identify |
| verified? | boolean | whether the email on this account has been verified | email |
| email? | ?string | the user's email | email |
| flags? | integer | the [flags](#DOCS_RESOURCES_USER/user-object-user-flags) on a user's account | identify |
| 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? | ?string | the user's [avatar decoration hash](#DOCS_REFERENCE/image-formatting) | identify |

###### Example User

Expand Down

0 comments on commit 94fd286

Please sign in to comment.