Manual:Discord Functions
getDiscordDetail
- getDiscordDetail()
- Returns the text used for the Discord Rich Presence detail field. See Discord docs for a handy image reference on where the detail is shown.
See also: setDiscordDetail
Note: Available since Mudlet 3.14
- Example
print("Discord detail is: ".. getDiscordDetail())getDiscordLargeIcon
- getDiscordLargeIcon()
- Returns the large icon name used for the Discord Rich Presence. See Discord docs for a handy image reference on where the large icon is shown.
See also: setDiscordLargeIcon
Note: Available since Mudlet 3.14
- Example
print("Discord large icon is: ".. getDiscordLargeIcon())getDiscordLargeIconText
- getDiscordLargeIconText()
- Returns the text used as a tooltip for the large icon in the Discord Rich Presence. See Discord docs for a handy image reference on where the large icon is shown.
See also: setDiscordLargeIconText
Note: Available since Mudlet 3.14
- Example
print("Discord large icon tooltip is: ".. setDiscordLargeIconText())getDiscordParty
- getDiscordParty()
- Returns the current and max party values used in the Discord Rich Presence. See Discord docs for a handy image reference on where the the party info is shown.
See also: setDiscordParty
Note: Available since Mudlet 3.14
- Example
local currentsize, maxsize = getDiscordParty()
print(string.format("Discord party: %d out of %d", currentsize, maxsize))getDiscordSmallIcon
- getDiscordSmallIcon()
- Returns the small icon name used for the Discord Rich Presence. See Discord docs for a handy image reference on where the small icon is shown.
See also: setDiscordSmallIcon
Note: Available since Mudlet 3.14
- Example
print("Discord small icon is: ".. getDiscordSmallIcon())getDiscordSmallIconText
- getDiscordSmallIconText()
- Returns the text used as a tooltip for the small icon in the Discord Rich Presence. See Discord docs for a handy image reference on where the small icon is shown.
See also: setDiscordSmallIconText
Note: Available since Mudlet 3.14
- Example
print("Discord small icon tooltip is: ".. setDiscordSmallIconText())getDiscordState
- getDiscordState()
- Returns the text used for the Discord Rich Presence state field. See Discord docs for a handy image reference on where the state is shown.
See also: setDiscordState
Note: Available since Mudlet 3.14
- Example
print("Discord state is: ".. getDiscordState())setDiscordApplicationID
- setDiscordApplicationID()
- Set a custom Discord ID so Discord Rich Presence will show "Playing <your game>" instead of "Playing Mudlet". This function is intended for game authors. Note that you can also set it automatically over GMCP, no pre-installation of scripts required. The Discord privacy option "Enable Lua API" must be enabled for this to work. Returns true if the Discord application ID is in the correct format.
If you're a game author, you can register your game over at Discord to obtain the "client ID" to be used for this function. Once you do so, make sure to upload the games icon as an art asset under the name of server-icon.
Mudlet calls the client ID an application ID to avoid confusion with the Discord's own client.
See also: setDiscordGame
Note: Available since Mudlet 3.14
- Example
-- set the ID to Mudlets own as an example
setDiscordApplicationID("450571881909583884")setDiscordDetail
- setDiscordDetail()
- Sets the text to be shown in the detail field of Discord Rich Presence. See Discord docs for a handy image reference on where the detail is shown. Note that this will overwrite the same information set by setDiscordGame().
See also: getDiscordDetail, setDiscordGame
Note: Available since Mudlet 3.14
- Example
-- set detail to your character name in-game, as an example
setDiscordDetail("Vadi")setDiscordElapsedStartTime
- setDiscordElapsedStartTime(time)
- Sets the time to be shown for "## elapsed" field in Discord Rich Presence. See Discord docs for a handy image reference on where the elapsed time is shown.
- Parameters
- time: (required) time as a Unix time. To get the current Unix time in Lua, use
os.time(os.date("*t")).
See also: setDiscordRemainingEndTime
Note: Available since Mudlet 3.14
- Example
-- set the timer to start counting up from now:
setDiscordElapsedStartTime(os.time(os.date("*t")))setDiscordGame
- setDiscordGame()
- Sets the given game to be shown in the "detail" field and the game's icon as the large icon in Discord Rich Presence. See Discord docs for a handy image reference on where the detail and large icon is shown. This is an alternative way of showing which game you're playing - a better way, if you're the game author, is to use GMCP (no pre-installation of scripts required) or setDiscordApplicationID().
Currently supported games are: Achaea, Aetolia, Imperian, Luminari, Lusternia, MidMUD, Starmourn, WoTMUD. To add a new game to the list, get in touch.
See also: setDiscordApplicationID
Note: Available since Mudlet 3.14
- Example
setDiscordGame("WoTMUD")setDiscordLargeIcon
- setDiscordLargeIcon()
- Sets the large icon to be shown in Discord Rich Presence. See Discord docs for a handy image reference the icon is shown.
Icons supported by default in Mudlet: armor, axe, backpack, bow, coin, dagger, envelope, gem-blue, gem-green, gem-red, hammer, heart, helmet, map, shield, tome, tools, wand, wood-sword (icons credit). To add a new icon to the list, get in touch (the Discord limit is 150 icons).
If you're a game author, you can register your own game with Discord and upload your own icons instead of using the ones registered by Mudlet, see setDiscordApplicationID().
See also: getDiscordLargeIcon, setDiscordLargeIconText, setDiscordApplicationID
Note: To ensure privacy, the icon will only be shown if the Lua API is enabled and the large icon is not hidden.
Note: Available since Mudlet 3.14.
- Example
setDiscordLargeIcon("coin")
setDiscordLargeIconText("Fishing")
setDiscordState("Fishing")setDiscordLargeIconText
- setDiscordLargeIconText()
- Sets the tooltip for the large icon in the Discord Rich Presence. See Discord docs for a handy image reference the large icon is shown.
See also: setDiscordLargeIcon
Note: To ensure privacy, the tooltip will only be shown if the Lua API is enabled and neither the large icon nor the large icon tooltip is not hidden.
Note: Available since Mudlet 3.14.
- Example
setDiscordLargeIcon("axe")
setDiscordLargeIconText("Killing heterics")setDiscordParty
- setDiscordParty(current, max)
- Sets the party information the Discord Rich Presence. See Discord docs for a handy image reference the party is shown.
- Parameters
- current: (required) current party amount.
- max: (optional) max party amount - if not provided, then the max is set to the current amount.
See also: getDiscordParty
Note: To ensure privacy, the party will only be shown if the Lua API is enabled and the party information is not hidden.
Note: Available since Mudlet 3.14.
- Example
-- show that 5 out of 10 people are in currently in the party
setDiscordParty(5, 10)setDiscordRemainingEndTime
- setDiscordRemainingEndTime(time)
- Sets the time to be shown for "## remaining" field in Discord Rich Presence. See Discord docs for a handy image reference on where the remaining time is shown.
- Parameters
- time: (required) time as a Unix time. To get the current Unix time in Lua, use
os.time(os.date("*t")).
See also: setDiscordElapsedStartTime
Note: Available since Mudlet 3.14
- Example
-- set the timer to start counting down from an hour from now
lua setDiscordRemainingEndTime(os.time(os.date("*t"))+(60 * 60))setDiscordSmallIcon
- setDiscordSmallIcon()
- Sets the small icon to be shown in Discord Rich Presence. See Discord docs for a handy image reference the icon is shown.
Icons supported by default in Mudlet: armor, axe, backpack, bow, coin, dagger, envelope, gem-blue, gem-green, gem-red, hammer, heart, helmet, map, shield, tome, tools, wand, wood-sword (icons credit). To add a new icon to the list, get in touch (the Discord limit is 150 icons).
If you're a game author, you can register your own game with Discord and upload your own icons instead of using the ones registered by Mudlet, see setDiscordApplicationID().
See also: getDiscordSmallIcon, setDiscordSmallIconText, setDiscordApplicationID
Note: To ensure privacy, the icon will only be shown if the Lua API is enabled and the small icon is not hidden.
Note: Available since Mudlet 3.14.
- Example
setDiscordSmallIcon("envelope")
setDiscordSmallIconText("Writing letters")
setDiscordState("Writing letters")setDiscordSmallIconText
- setDiscordSmallIconText()
- Sets the tooltip for the small icon in the Discord Rich Presence. See Discord docs for a handy image reference the small icon is shown.
See also: setDiscordSmallIcon
Note: To ensure privacy, the tooltip will only be shown if the Lua API is enabled and neither the small icon nor the small icon tooltip is not hidden.
Note: Available since Mudlet 3.14.
- Example
setDiscordSmallIcon("map")
setDiscordSmallIconText("Exploring")