Skip to main content
Version: 3.x

Configuring the mod

Notice

Simple RPC now includes a basic in-game config screen, that is available when Cloth Config is installed. You can find the button at the TOP right corner of the OPTIONS screen. This config screen does not yet support Buttons, or Dimension Overrides. It's still suggested to use our Config Editor App. It includes Live preview and fetches the available images directly from discord!

Information​

Simple RPC uses a universal TOML based config system, with a well named Layout and comments. You can use the same config file on Forge/Fabric, without having to redo it.

In addition to the basic Rich Presence options, the mod also includes features such as Server Side config Overrides, Defining a custom Rich Presence based on the server you're connected to as well as including a translated Rich Presence, based on the language of the player.

Finding your config files:​

Before 3.1: config/simple-rpc.toml

Version 3.1: simple-rpc/simple-rpc.toml

Version 3.2+ config/simple-rpc/simple-rpc.toml

warning

You do not need to restart the game while editing the config. The config will AUTO RELOAD when the file is saved

Config Types​

This is the default config that you will use.

This contains all the config for your rich presence such as your discord ID, assets and texts.

You can find this file at:

Before 3.1: config/simple-rpc.toml

Version 3.1: simple-rpc/simple-rpc.toml

Version 3.2+ config/simple-rpc/simple-rpc.toml

Below is a copy of the default, unconfigured config shipped with the mod.

#General Config Section. See https://readme.firstdarkdev.xyz/simple-rpc/introduction/
[general]
    #The Application ID of the Discord App to use
    applicationID = 904387784289161227
    #Enable/Disable the mod
    enabled = true
    #Enable/Disable debugging mode. WARNING: MAY CAUSE LOG SPAM!
    debugging = false
    #Enable/Disable the in game config screen. ONLY AVAILABLE WHEN CLOTH CONFIG IS INSTALLED!
    configScreen = false
    #Display the Icon and Pack Name in place of LargeImage from compatible launchers. DOES NOT WORK WITH CUSTOM APPS! ONLY THE DEFAULT ONE!
    launcherIntegration = false
    #Internal Version Number. NO TOUCHY!
    version = 18

#The Game Loading event
[init]
    #Enable/Disable the Game Loading Event
    enabled = true
    #The first line of text under the app name
    description = "KBP is loading"
    #The second line of text under the app name
    state = "Game Starting..."
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Main Menu event
[main_menu]
    #Enable/Disable the Main Menu Event
    enabled = true
    #The first line of text under the app name
    description = "%player% is currently pondering which world to conquer"
    #The seconds line of text under the app name
    state = "Idling in the menu"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Server List event
[server_list]
    #Enable/Disable the Server List Event
    enabled = true
    #The first line of text under the app name
    description = "%player% is looking for a server"
    #The second line of text under the app name
    state = "Searching for friends"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Realms Screen event
[realms_list]
    #Enable/Disable the Realms Screen Event
    enabled = true
    #The first line of text under the app name
    description = "%player% is looking for a Realm"
    #The second line of text under the app name
    state = "Browsing Realms"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["mclogonew"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["mclogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "%mods% mods installed"
    #The buttons to display on Discord
    buttons = []

#The Join Game Event
[join_game]
    #Enable/Disable the Join Game Event
    enabled = true
    #The first line of text under the app name
    description = "%player% is joining a game"
    #The second line of text under the app name
    state = "Joining Game"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Single Player Event
[single_player]
    #Enable/Disable the Single Player Event
    enabled = true
    #The first line of text under the app name
    description = "Currently In %world%"
    #The second line of text under the app name
    state = "Playing lonely mode"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Multi Player Event
[multi_player]
    #Enable/Disable the Multi Player Event
    enabled = true
    #The first line of text under the app name
    description = "Playing on %servername% with %players% players"
    #The second line of text under the app name
    state = "Playing online"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["modpacklogo"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but a boomer shooter"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["modpacklogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "KBP is running"
    #The buttons to display on Discord
    buttons = []

#The Realms Game Event
[realms]
    #Enable/Disable the Realms Game Event
    enabled = true
    #The first line of text under the app name
    description = "Playing on %realmname%"
    #The second line of text under the app name
    state = "Playing on a Realm"
    #The Asset ID of the image to display as the large image
    largeImageKey = ["mclogonew"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but modded"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["mclogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "%realmdescription%"
    #The buttons to display on Discord
    buttons = []

#Fallback event for disabled events
[generic]
    #The first line of text under the app name
    description = "Playing Minecraft"
    #The second line of text under the app name
    state = ""
    #The Asset ID of the image to display as the large image
    largeImageKey = ["mclogonew"]
    #The text that gets displayed when the large image is hovered
    largeImageText = "It's Minecraft %mcver%, but modded"
    #The Asset ID of the image to display as the small image
    smallImageKey = ["mclogo"]
    #The text that gets displayed when the small image is hovered
    smallImageText = "%mods% mods installed"
    #The buttons to display on Discord
    buttons = []

#Custom Config Variables that you can use
[custom]
    #Must these variables be parsed along with other variables
    enabled = true
    #Your custom variables to add
    [[custom.variables]]
        name = "testvar"
        value = "This is my Custom Var"

#Dimension Information Overrides
[dimension_overrides]
#Allows you to override the displayed values for dimensions
    enabled = true
    
    #The Dimensions to override
    [[dimension_overrides.dimensions]]
        name = "overworld"
        description = "Exploring the Failed Earth"
        state = "TESTING"
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "the_nether"
        description = "Crawling in Hell"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "the_end"
        description = "Within the Corrupted Zone"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "atum:atum"
        description = "Gaining strength in the Ancient Terrain"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "stacked_dimensions_warden:deeper_dark"
        description = "Mining in the Forbidden Caverns"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "dimdungeons:dungeon_dimension"
        description = "Raiding the Secret Pockets"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []
    
    [[dimension_overrides.dimensions]]
        name = "lostcities:lostcity"
        description = "Adventuring in the Lost World"
        state = ""
        largeImageKey = ["modpack_logo"]
        largeImageText = ""
        smallImageKey = ["modpack_logo"]
        smallImageText = "KBP is running"
        buttons = []

Configuration Variables​

Information​

Variables are pieces of text added to the config file that allows you to display data from the game on your status.

These variables can be used inside any state, description, largeImageText, smallImageText and inside buttons.

Some variables can also be used inside largeImageKey and smallImageKey. These are marked with IMAGE

These variables can be used with Single Player, Multi Player and Realms.

VariableDescription
%player%Shows the Minecraft name of the player
%world%Shows the current world (Dimension): For example overworld/nether/etc
%mods%Shows the total amount of installed mods
%difficulty%Shows the difficulty of the current game
%position%Shows the position of the player
%biome%Show the name of the biome you're in
%mcver%Show the Minecraft Version: For example 1.16.5
%instance%Shows the name of the Instance on supported launchers
%launcher%Shows the name of the Launcher on supported launchers
%server% IMAGEReturns the server IP with _ instead of . So 127.0.0.1 becomes 127_0_0_1. Can be used to change the image key based on the server address
%launchername%Get the name of the launcher (if supported) in lower-case
%savename%Shows the name of your world Since 2.6
%playerhead% IMAGEUses the Face of the player as an Image Key. No need to have them uploaded
%gametime12%Returns the In-Game time, in 12 Hour Format. For example: 01:00 PM
%gametime%Returns the In-Game time in 24 Hour Format. For example: 13:00
%day%Returns the In-Game day as shown in F3
%weather%Returns the current weather of the biome the player is in
%replayframe%Used with ReplayMod to show the currently rending frame
%replaytotal%Used with ReplayMod to show the total frames to be rendered
%replaytime%Used with ReplayMod to show the current render time
%replaytimeleft%Used with ReplayMod to show the total render time left