Manual:Discord Functions

Discord Functions

All functions to customize the information Mudlet displays in Discord's rich presence interface. For an overview on how all of these functions tie in together, see our Discord scripting overview.

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

Available in Mudlet3.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

Available in Mudlet3.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

Available in Mudlet3.14+

Example

print("Discord large icon tooltip is: ".. getDiscordLargeIconText())

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

Available in Mudlet3.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

Available in Mudlet3.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

Available in Mudlet3.14+

Example

print("Discord small icon tooltip is: ".. getDiscordSmallIconText())

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

Available in Mudlet3.14+

Example

print("Discord state is: ".. getDiscordState())

getDiscordTimeStamps

getDiscordTimeStamps()

Returns the start/end Discord timestamps as set by setDiscordElapsedStartTime() and setDiscordRemainingEndTime().

See also: setDiscordElapsedStartTime, setDiscordRemainingEndTime

Available in Mudlet3.14+

Example

display(getDiscordTimeStamps())

resetDiscordData

resetDiscordData()

Reset Discord Rich Presence for current profile to the Mudlet default settings.

See also

setDiscordApplicationID(), setDiscordDetail(), setDiscordState()

Available in Mudlet4.14+

Example

-- Use 'afk' emote in game, clear Discord party status and estimate return
send("afk")
resetDiscordData()
setDiscordState("Back in 15")
setDiscordRemainingEndTime(os.time(os.date("*t"))+(60 * 15))

setDiscordApplicationID

setDiscordApplicationID(id)

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. This will currently (as of Mudlet 4.9.1) bypass the Discord privacy option "Enable Lua API" on future sessions if a non-empty id is specified. 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 this the Application ID to avoid confusion with Mudlet being a game client - however Discord uses both Application ID and Client ID to refer to this detail (which seems to be an 18 digit number).

Parameters

• id: (required) id as a string.

See also: setDiscordGame, usingMudletsDiscordID

Available in Mudlet3.14+

Example

-- set the ID to Mudlets own as an example
setDiscordApplicationID("450571881909583884")

Note: So you do not have to remember that long number you can also reset to the default Mudlet ID by calling this function without an argument:

setDiscordApplicationID()

setDiscordDetail

setDiscordDetail(text)

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: To ensure privacy, the detail will only be shown if the Lua API is enabled and the detail is not hidden.

Available in Mudlet3.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: To ensure privacy, the time will only be shown if the Lua API is enabled and the time is not hidden.

Available in Mudlet3.14+

Example

-- set the timer to start counting up from now:
setDiscordElapsedStartTime(os.time(os.date("*t")))

setDiscordGame

setDiscordGame(text)

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: To ensure privacy, the game and icon will only be shown if the Lua API is enabled, and detail and large icon are set to show.

Available in Mudlet3.14+

Example

setDiscordGame("WoTMUD")

setDiscordGameUrl

setDiscordGameUrl([url], [name])

Set or clear the game Discord invite URL via Lua. It has the same effect as the GMCP message External.Discord.Info.

Available in Mudlet4.14+

Note: This will update some menu options.

Parameters

• url:

(optional) URL of Discord invite

• name:

(optional) Name of game

Example

-- set Discord invite to CoffeeMUD
setDiscordGameUrl("https://discord.gg/HgDxtas", "CoffeeMUD")

-- remove the Discord invite
setDiscordGameUrl()

setDiscordLargeIcon

setDiscordLargeIcon(iconName)

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.

Available in Mudlet3.14+

Example

setDiscordLargeIcon("coin")
setDiscordLargeIconText("Fishing")
setDiscordState("Fishing")

setDiscordLargeIconText

setDiscordLargeIconText(text)

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 large icon with the large icon tooltip is set to show.

Available in Mudlet3.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.

Available in Mudlet3.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: To ensure privacy, the time will only be shown if the Lua API is enabled and the time is not hidden.

Available in Mudlet3.14+

Example

-- set the timer to start counting down from an hour from now
setDiscordRemainingEndTime(os.time(os.date("*t"))+(60 * 60))

setDiscordSmallIcon

setDiscordSmallIcon(iconName)

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.

Available in Mudlet3.14+

Example

setDiscordSmallIcon("envelope")
setDiscordSmallIconText("Writing letters")
setDiscordState("Writing letters")

setDiscordSmallIconText

setDiscordSmallIconText(text)

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 small icon with the small icon tooltip is set to show.

Available in Mudlet3.14+

Example

setDiscordSmallIcon("map")
setDiscordSmallIconText("Exploring")

setDiscordState

setDiscordState(state)

Sets the text to be shown in the state field of Discord Rich Presence. See Discord docs for a handy image reference on where the state is shown.

See also: getDiscordState, setDiscordDetail

Note: To ensure privacy, the state will only be shown if the Lua API is enabled and the state is not hidden.

Available in Mudlet3.14+

Example

-- set state to your current area
local currentarea = getRoomArea(getPlayerRoom())
local areaname = getAreaTableSwap()[currentarea]
setDiscordDetail(areaname)

usingMudletsDiscordID

usingMudletsDiscordID()

Returns true if the currently playing game is set to "Mudlet". You can change this with setDiscordApplicationID().

See also: setDiscordApplicationID

Available in Mudlet3.14+

Example

if usingMudletsDiscordID() then
  print('It is showing "Playing Mudlet" right now!')
end