Local Development
Run Your Application Locally
Get up and running with a local development application.
Launch Your App from Discord
How to launch your app on mobile and desktop Discord clients.
Setup URL Mapping
Configure the Discord proxy to allow network requests to necessary external endpoints.
Logging
How to use the various levels of logging while building your application.
User Actions
Open External Link
Open an external link from within your app.
Open Invite Dialog
Open the Application Channel Invite dialog within Discord.
Open Share Moment Dialog
Open a dialog to share media from your application to a channel, DM, or GDM.
Setting Up an Entry Point Command
Configure a command that allows users to open your Activity from the App Launcher.
Encourage Hardware Acceleration
Open a dialog to enable hardware acceleration for compute-intensive applications.
Mobile
Supporting Mobile Platforms
Update your application settings to support iOS and Android.
Mobile Safe Areas
Ensure that your app’s assets fall within mobile-safe areas.
Mobile Thermal States
Respond to thermal state changes surfaced from iOS and Android.
Layout
Application Orientation
Configure and subscribe to changes in application orientation.
Application Layout Mode
Subscribe to layout mode changes to update your application’s user interface.
Networking
Activity Proxy Considerations
Working with our Activity Proxy
Construct a Full URL
Generate a full URL when working with network requests.
Using External Resources
Allow network requests to external resources from inside the Discord proxy.
Security Considerations
Keep things safe and secure in your Activity.
Multiplayer Experience
Instance Management
Managing instances to ensure users join the same instance as their friends.
Instance Participants
Use the SDK to fetch the users currently connected to an instance.
Render Avatars and Names
Retrieve and render the usernames and avatars of users connected to your application.
Preventing Unwanted Activity Sessions
Validating activity sessions are via a Discord client before adding them to an instance’s session.
Growth and Referrals
Prompting Users to Share Incentivized Links
Encourage your users to share links to your activity by adding tracking and offering rewards for engagement.
Creating and Managing Custom Incentivized Links
For off-platform sharing of rewards, promotions, or limited time experiences.
Generating a Custom Link Within Your Activity
An API to be able to generate ephemeral links with a customizable embed.
Assets & Metadata
Setting Up Activity Metadata
Best practices for configuring how your application shows up in Discord.
Setting Up Art Assets
Best practices for configuring how your application shows up in Discord.
Rich Presence
Integrating Rich Presence
Display live activity data on user profiles while they play your Activity.
Rich Presence Best Practices
Design tips and a launch checklist for a polished Rich Presence integration.
Production Readiness
Cache Busting
Manage asset caching in your application and the Discord Activity proxy.
Handling Rate Limits
Stay within rate limits to keep the fun going in your Activity.
Static IP Addresses
Network routing considerations when preparing your Activity for production use.
Backward Compatibility
Future-proof your application and support new commands as they become available in the SDK.