Simple Discord RPC Mod — Guide
Discord Developer Portal Integration
To use custom images and a custom application name, users must set up a Discord Application. This process allows the mod to display high-quality assets instead of generic icons.
- The name of this application will be the 'Playing...
- Client ID: The 'Application ID' found in the General Information tab must be pasted into the
appIDfield in the mod's config file. - Rich Presence Assets: Under the 'Rich Presence' tab, users can upload 'Art Assets'. These images are given names (keys) which are then referenced in the
simple-rpc.tomlfile under the[images]section.
Dimension Overrides
Simple Discord RPC allows for specific configurations based on the dimension the player is currently exploring. This is handled in the [dimension_overrides] section of the configuration file.
Each dimension (e.g., minecraft:the_nether, minecraft:the_end) can have its own:
* Large Image: A specific icon for that dimension.
* Large Image Text: Hover text for the icon.
* Details: The top line of text in the RPC.
* State: The bottom line of text in the RPC.
This allows a player's profile to change from 'Exploring the Overworld' with a grass block icon to 'Surviving the Nether' with a fire icon automatically upon teleportation.
Buttons and Interactivity
The mod supports up to two custom buttons that appear on the player's Discord profile. These are configured in the [buttons] section.
Button Configuration Fields
- Label: The text displayed on the button (e.g., 'Join our Website').
- URL: The destination link when the button is clicked.
Note: Due to Discord's security policies, buttons may not be clickable for the player themselves, but they will be fully functional for other users viewing the player's profile.
Core Mechanics
It gathers data from the Minecraft client—such as the current world, player stats, and loaded mods—and formats it into a Rich Presence update.
Key Features
- Dynamic Placeholders: Use variables to show live data like coordinates, health, or server IP.
- Dimension Awareness: Change the display icon or text automatically when entering the Nether, the End, or custom modded dimensions.
-
Custom Buttons: Add clickable links to your Discord profile, such as a link to a wiki, a website, or a server store.
-
Config Editor Support: Compatible with a dedicated external application for visual configuration editing.