Skip to content

Commit 3854d8a

Browse files
authored
Merge branch 'discord:main' into basic-authentication
2 parents d7842f9 + b70346a commit 3854d8a

File tree

110 files changed

+3088
-992
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+3088
-992
lines changed

docs/Intro.mdx

Lines changed: 71 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -3,50 +3,74 @@ showTOC: false
33
sidebar_label: Intro
44
---
55

6-
![Welcome to the Discord Developer Platform](docs-header.svg)
7-
8-
# Welcome to the Discord Developer Platform
9-
10-
The Discord developer platform lets you develop apps to customize and extend Discord for millions of users. A toolkit of [APIs](#DOCS_REFERENCE) and [resources](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES) pair splendidly with a supportive community to help you build bots, integrate 3rd party services, and add Discord support to your game.
11-
12-
<Button href="https://discord.com/developers/docs/getting-started" color="brand">Get Started</Button>
13-
14-
---
15-
16-
## Explore the Platform
17-
18-
#### Engage with Users
19-
20-
Add interactivity to your app with [commands](#DOCS_INTERACTIONS_APPLICATION_COMMANDS) and [message components](#DOCS_INTERACTIONS_MESSAGE_COMPONENTS) to build engaging experiences in the place where users are already hanging out.
21-
22-
#### Customize Servers
23-
24-
Customize Discord servers by using apps to do things like [send messages](#DOCS_RESOURCES_MESSAGE/create-message), modify [channels](#DOCS_RESOURCES_CHANNEL) and [guilds](#DOCS_RESOURCES_GUILD), [integrate with AutoMod](#DOCS_RESOURCES_AUTO_MODERATION), or [connect to voice](#DOCS_TOPICS_VOICE_CONNECTIONS).
25-
26-
Plus, use the [Gateway API](#DOCS_TOPICS_GATEWAY) to respond to [real-time events](#DOCS_TOPICS_GATEWAY_EVENTS/receive-events) happening in a server, like when a reaction is added to a message.
27-
28-
#### Connect Metadata
29-
30-
Link and update metadata to enhance Discord for users. Add [Rich Presence](#DOCS_RICH_PRESENCE_OVERVIEW) to display live data on users' profiles, or [connection metadata](#DOCS_RESOURCES_APPLICATION_ROLE_CONNECTION_METADATA) to make it easy for admins to create roles using metadata associated with your app.
31-
32-
#### Build Interactive Activities and Games
33-
34-
Currently in Developer Preview, the [Embedded App SDK](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK) allows you to build [Activities](#DOCS_ACTIVITIES_OVERVIEW), such as multiplayer games or social experiences, that run inside Discord.
35-
36-
## Discover Developer Resources
37-
38-
#### Find Tools and Libraries
39-
40-
The Discord developer community has built and maintained a ton of different [libraries and tools](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES/libraries) over the years. No matter your experience level or language of choice, there are resources to speed up and simplify app development for you over on the [Community Resources](#DOCS_DEVELOPER_TOOLS_COMMUNITY_RESOURCES) page.
41-
42-
You can also check out our [Postman collections](https://www.postman.com/discord-api) to try and test API endpoints.
43-
44-
#### Connect with Support
45-
46-
- Join the [Discord Developers server](https://discord.gg/discord-developers) for support, discussion, and events about the Discord developer platform.
47-
- Explore the [Developer Help Center](https://support-dev.discord.com/hc) to find articles about common topics and questions, or to reach directly out to our developer support team.
48-
- Use our [GitHub](https://github.com/discord/discord-api-docs) to report API bugs, start a discussion about a developer feature request, or suggest an edit to our open source developer documentation.
49-
50-
So go ahead and [build an app](https://discord.com/developers/applications)! We can’t wait to see what you make.
51-
52-
— Discord
6+
<Hero title="Build Where the World Plays" subheading="Build social games, experiences, and integrations for millions of users on Discord" />
7+
8+
## Get Started
9+
10+
Learn more about what apps can do on Discord or jump right into building your own.
11+
12+
<Container>
13+
<Card title="Overview of Apps" link="#DOCS_QUICK_START_OVERVIEW_OF_APPS" icon="AppsIcon">
14+
Learn more about the different types of apps you can build on Discord and how users can interact with them
15+
</Card>
16+
<Card title="Build your First Discord App" link="#DOCS_QUICK_START_GETTING_STARTED" icon="RobotIcon">
17+
Follow the guide to build a Discord app with interactive features like commands and message components.
18+
</Card>
19+
<Card title="Build a Discord Activity" link="#DOCS_ACTIVITIES_BUILDING_AN_ACTIVITY" icon="GameControllerIcon">
20+
Follow the guide to build an Activity in Discord using the Embedded App SDK.
21+
</Card>
22+
</Container>
23+
24+
## Discover Platform Features
25+
26+
Learn about different features and explore their reference documentation to bring your idea to life.
27+
28+
<Container>
29+
<Card title="Messaging" link="#DOCS_RESOURCES_MESSAGE" icon="ChatIcon">
30+
Send, retrieve, and manage messages in channels where your app has access.
31+
</Card>
32+
<Card title="Message Components" link="#DOCS_INTERACTIONS_OVERVIEW/message-components" icon="SparklesIcon">
33+
Add interactive elements like buttons and select menus in messages sent by your app.
34+
</Card>
35+
<Card title="Commands" link="#DOCS_INTERACTIONS_OVERVIEW/commands" icon="SlashBoxIcon">
36+
Create interactive entry points for your app's features that can be accessed across Discord.
37+
</Card>
38+
<Card title="Activities" link="#DOCS_ACTIVITIES_OVERVIEW" icon="GameControllerIcon">
39+
Build embedded games and social experiences that are launchable in Discord.
40+
</Card>
41+
<Card title="Monetization" link="#DOCS_MONETIZATION_OVERVIEW" icon="PiggyBankIcon">
42+
Integrate native monetization features like subscriptions and one-time purchases.
43+
</Card>
44+
<Card title="Rich Presence" link="#DOCS_RICH_PRESENCE_OVERVIEW" icon="UserIcon">
45+
Display actionable data in a user's profile about what they're doing in your game or app.
46+
</Card>
47+
</Container>
48+
49+
## Explore the APIs
50+
51+
Learn about some of the different APIs Discord apps have access to.
52+
53+
<Container>
54+
<Card title="HTTP API" link="#DOCS_REFERENCE/http-api">
55+
Fetch information about and modify core Discord resources like channels, servers, users, and messages.
56+
</Card>
57+
<Card title="Gateway API" link="#DOCS_REFERENCE/gateway-websocket-api" >
58+
Receive and send realtime events over a WebSocket connection for things happening in Discord.
59+
</Card>
60+
</Container>
61+
62+
## Find Support
63+
64+
Reach out to the community or developer support to get support and stay updated about API changes.
65+
66+
<Container>
67+
<Card title="Discord Developer Server" link="https://discord.gg/discord-developers" icon="ClydeIcon">
68+
Join our community for support, API announcements, and events hosted by Discord staff.
69+
</Card>
70+
<Card title="Find us on GitHub" link="https://github.com/discord/discord-api-docs" icon="ForumIcon">
71+
Visit us on GitHub to report API bugs, provide platform feature requests, or to suggest updates to the documentation.
72+
</Card>
73+
<Card title="Developer Help Center" link="https://support-dev.discord.com" icon="UnknownGameIcon">
74+
Find articles on common topics and questions, or reach directly out to the developer support team.
75+
</Card>
76+
</Container>

docs/Reference.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ All HTTP-layer services and protocols (e.g. HTTP, WebSocket) within the Discord
133133

134134
## Snowflakes
135135

136-
Discord utilizes Twitter's [snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID. Because Snowflake IDs are up to 64 bits in size (e.g. a uint64), they are always returned as strings in the HTTP API to prevent integer overflows in some languages. See [Gateway ETF/JSON](#DOCS_TOPICS_GATEWAY/encoding-and-compression) for more information regarding Gateway encoding.
136+
Discord utilizes Twitter's [snowflake](https://github.com/twitter-archive/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (IDs). These IDs are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parent's ID. Because Snowflake IDs are up to 64 bits in size (e.g. a uint64), they are always returned as strings in the HTTP API to prevent integer overflows in some languages. See [Gateway ETF/JSON](#DOCS_EVENTS_GATEWAY/encoding-and-compression) for more information regarding Gateway encoding.
137137

138138
###### Snowflake ID Broken Down in Binary
139139

@@ -252,7 +252,7 @@ Certain endpoints in the API are documented to accept booleans for their query s
252252

253253
## Gateway (WebSocket) API
254254

255-
Discord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455). For information on opening Gateway connections, please see the [Gateway API](#DOCS_TOPICS_GATEWAY/connections) section.
255+
Discord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455). For information on opening Gateway connections, please see the [Gateway API](#DOCS_EVENTS_GATEWAY/connections) section.
256256

257257
## Message Formatting
258258

@@ -344,7 +344,7 @@ Discord uses ids and hashes to render images in the client. These hashes can be
344344
| Avatar Decoration | avatar-decoration-presets/[avatar_decoration_data_asset](#DOCS_RESOURCES_USER/avatar-decoration-data-object).png | PNG |
345345
| Application Icon | app-icons/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[icon](#DOCS_RESOURCES_APPLICATION/application-object).png | PNG, JPEG, WebP |
346346
| Application Cover | app-icons/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[cover_image](#DOCS_RESOURCES_APPLICATION/application-object).png | PNG, JPEG, WebP |
347-
| 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 |
347+
| Application Asset | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/[asset_id](#DOCS_EVENTS_GATEWAY_EVENTS/activity-object-activity-assets).png | PNG, JPEG, WebP |
348348
| Achievement Icon | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/achievements/[achievement_id](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct)/icons/[icon_hash](https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Achievements.md#user-achievement-struct).png | PNG, JPEG, WebP |
349349
| Store Page Asset | app-assets/[application_id](#DOCS_RESOURCES_APPLICATION/application-object)/store/asset_id | PNG, JPEG, WebP |
350350
| Sticker Pack Banner | app-assets/710982414301790216/store/[sticker_pack_banner_asset_id](#DOCS_RESOURCES_STICKER/sticker-pack-object).png | PNG, JPEG, WebP |

0 commit comments

Comments
 (0)