Skip to content

Commit ca29659

Browse files
committed
Update "building an activity" docs per new enable flow
1 parent 2b4d66f commit ca29659

File tree

3 files changed

+17
-18
lines changed

3 files changed

+17
-18
lines changed

docs/activities/Building_An_Activity.mdx

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -134,22 +134,6 @@ Details about installation contexts is in the [Application documentation](#DOCS_
134134

135135
Click on **Installation** in the left sidebar, then under **Installation Contexts** make sure both "User Install" and "Guild Install" are selected. This will make sure users can launch our app's Activity across Discord servers, DMs, and Group DMs.
136136

137-
### Enable Activities
138-
139-
Next, we'll need to enable Activities for your app. On the left hand sidebar under **Activities**, click **Getting Started**.
140-
141-
Review this page and press **Enable**.
142-
143-
![Enabling Activities in Settings](activities/getting-started-activities.png)
144-
145-
After enabling Activities, you'll see the different Activity-related pages in your app's settings under the **Activities** section. Across these pages, you'll be able to update information like supported platforms, upload assets, and configure Activity-specific settings. We'll come back to this section later in the guide to set up URL mappings.
146-
147-
#### Default Entry Point Command
148-
149-
When you enable Activities for your app, a [default Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/default-entry-point-command) called "Launch" is automatically created. This [Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-commands) is the primary way for users to launch your Activity in Discord.
150-
151-
By default, interactions with this command will result in Discord opening your Activity for the user and posting a message in the channel where it was launched from. However, if you prefer to handle the interactions in your app, you can update the [`handler` field](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-handlers) or create your own. Additional details are in the Entry Point command [documentation](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-commands) and [development guide](#DOCS_ACTIVITIES_DEVELOPMENT_GUIDES/setting-up-an-entry-point-command).
152-
153137
### Add a Redirect URI
154138

155139
Next, we'll add a Redirect URI, which is where a user is typically redirected to after authorizing with your app when going through the standard OAuth flow. While setting up a Redirect URI is required, the Embedded App SDK automatically handles redirecting users back to your Activity when the RPC [`authorize` command](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/authorize) is called.
@@ -187,7 +171,6 @@ Back in your app's settings, click on **OAuth2** on the sidebar:
187171
<Collapsible title="Step 2 Checkpoint" icon="list" open>
188172

189173
By the end of Step 2, make sure you have:
190-
- Created a Discord app with Activities enabled
191174
- Set up a placeholder Redirect URI
192175
- Added your app's Client ID and Client Secret to your project's `.env` file.
193176
</Collapsible>
@@ -266,7 +249,7 @@ By the end of Step 3, make sure you have:
266249
267250
## Step 4: Running your app in Discord
268251
269-
Let's ensure everything is wired up correctly, then run the Activity in Discord.
252+
Let's ensure everything is wired up correctly, enable activities via the dev portal, and then run the Activity in Discord.
270253
271254
### Run your app
272255
@@ -322,6 +305,21 @@ Back in your app's settings, click on the **URL Mappings** page under **Activiti
322305
323306
Read details about URL Mapping [in the development guide](#DOCS_ACTIVITIES_DEVELOPMENT_GUIDES/url-mapping).
324307
308+
### Enable Activities
309+
310+
Next, we'll need to enable Activities for your app. On the left hand sidebar under **Activities**, click **Settings**.
311+
312+
Find the first checkbox, labeled `Enable Activities`. Turn it on 🎉
313+
314+
![Enabling Activities in Settings](activities/enable-activities.png)
315+
316+
#### Default Entry Point Command
317+
318+
When you enable Activities for your app, a [default Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/default-entry-point-command) called "Launch" is automatically created. This [Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-commands) is the primary way for users to launch your Activity in Discord.
319+
320+
By default, interactions with this command will result in Discord opening your Activity for the user and posting a message in the channel where it was launched from. However, if you prefer to handle the interactions in your app, you can update the [`handler` field](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-handlers) or create your own. Additional details are in the Entry Point command [documentation](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-commands) and [development guide](#DOCS_ACTIVITIES_DEVELOPMENT_GUIDES/setting-up-an-entry-point-command).
321+
322+
325323
### Running your Activity in Discord
326324
327325
Now that we are pointing Discord to our locally running app, we can launch the Activity in Discord!
@@ -342,6 +340,7 @@ We're looking pretty good so far, but we haven't wired up any Discord functional
342340
By the end of Step 4, make sure you have:
343341
- Set up a public endpoint
344342
- Added an Activity URL Mapping in your app's settings
343+
- Enabled Activities for your app
345344
- Successfully launched your Activity in Discord
346345
</Collapsible>
347346
37.5 KB
Loading
-524 KB
Binary file not shown.

0 commit comments

Comments
 (0)