Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions modules/gmcp/files/data-overlays/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
################################################################################
# If modified, these settings will be copied into your config overrides
# folder under `Modules.gmcp`:
#
# Modules:
# gmcp:
# mapper_version: "1"
# mapper_url: "https://github.com/GoMudEngine/MudletMapper/releases/latest/download/GoMudMapper.mpackage"
# ui_version: "1"
# ui_url: "https://github.com/GoMudEngine/MudletUI/releases/latest/download/GoMudUI.mpackage"
# map_version: "1"
# map_url: "https://github.com/GoMudEngine/MudletMapper/releases/latest/download/gomud.dat"
# discord_application_id: "1298377884154724412"
# discord_invite_url: "https://discord.gg/FaauSYej3n"
# discord_details: "Using GoMudEngine"
# discord_state: "Exploring the world"
# discord_large_image_key: "server-icon"
# discord_small_image_key: "character-icon"
################################################################################

# Mudlet client configuration

# Mapper configuration
mapper_version: "1"
mapper_url: "https://github.com/GoMudEngine/MudletMapper/releases/latest/download/GoMudMapper.mpackage"

# UI configuration
ui_version: "1"
ui_url: "https://github.com/GoMudEngine/MudletUI/releases/latest/download/GoMudUI.mpackage"

# Map data configuration
map_version: "1"
map_url: "https://github.com/GoMudEngine/MudletMapper/releases/latest/download/gomud.dat"

# Discord Rich Presence configuration
discord_application_id: "1298377884154724412" # Default GoMud Discord Server
discord_invite_url: "https://discord.gg/FaauSYej3n" # Default GoMud Discord Server
discord_details: "Using GoMudEngine"
discord_state: "Exploring the world"
discord_large_image_key: "server-icon"
discord_small_image_key: "character-icon"
2 changes: 2 additions & 0 deletions modules/gmcp/files/data-overlays/keywords.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ help:
- checkclient
- mudletmap
- mudletui
integration:
- discord

# Aliases for keywords when typing: help <keyword>
help-aliases:
Expand Down
13 changes: 0 additions & 13 deletions modules/gmcp/files/data-overlays/mudlet-config.yaml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The <ansi fg="command">checkclient</ansi> command displays information about cli

<ansi fg="command">checkclient</ansi> - Shows details about detected client features and available enhancements

<ansi fg="yellow-bold">NOTES:</ansi>
<ansi fg="yellow-bold">Notes:</ansi>
- This command is particularly useful for Mudlet users to see what special features are available
- It will detect if you're using Mudlet and show relevant package information
- The command runs automatically when you log in to provide helpful information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This game supports various MUD clients with special features to enhance your gam
<ansi fg="white-bold">Other Clients</ansi> - Basic support with standard MUD protocol features
For the best experience, we recommend using a client that supports GMCP.

<ansi fg="subtitle">GMCP FEATURES:</ansi>
<ansi fg="yellow-bold">GMCP Features:</ansi>
- Character information and status updates
- Room and environment data
- Communication channels
Expand Down
29 changes: 29 additions & 0 deletions modules/gmcp/files/datafiles/templates/help/discord.template
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<ansi fg="black-bold">.:</ansi> <ansi fg="magenta">Help for </ansi><ansi fg="command">discord</ansi>

The <ansi fg="command">discord</ansi> command allows Mudlet client users to customize what information is shown in their Discord status.

<ansi fg="yellow">Usage: </ansi>

<ansi fg="command">discord</ansi> - Shows current settings and available commands

<ansi fg="command">discord info on|off</ansi> - Enable/disable Discord application info
<ansi fg="command">discord status on|off</ansi> - Enable/disable Discord status updates

<ansi fg="command">discord area on|off</ansi> - Show/hide current area in status
<ansi fg="command">discord party on|off</ansi> - Show/hide party information
<ansi fg="command">discord name on|off</ansi> - Show/hide character name
<ansi fg="command">discord level on|off</ansi> - Show/hide character level


<ansi fg="yellow-bold">Notes:</ansi>
- These commands only work if you are using a Mudlet client
- All settings default to enabled when not set
- Character name and level are shown in the format: "Name (lvl. X)"
- Party information includes party size and current area (if enabled)
- The info setting controls sending the Discord application ID
- The status setting controls sending presence updates to Discord
- Disabling either info or status will clear any cached data
- Settings persist between sessions
- Running <ansi fg="command">discord</ansi> without arguments shows current settings

<ansi fg="magenta-bold">See also:</ansi> <ansi fg="command">help client</ansi>, <ansi fg="command">checkclient</ansi>
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The <ansi fg="command">mudletmap</ansi> command sends map data to Mudlet clients

<ansi fg="command">mudletmap</ansi> - Sends or refreshes map data to your Mudlet client

<ansi fg="subtitle">NOTES:</ansi>
<ansi fg="yellow-bold">Notes:</ansi>
- This command only works if you are using a Mudlet client
- The map data helps with navigation and visualization of the game world
- This command runs automatically when you log in with Mudlet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The <ansi fg="command">mudletui</ansi> command allows Mudlet client users to man
<ansi fg="command">mudletui hide</ansi> - Hides automatic Mudlet UI prompts when logging in
<ansi fg="command">mudletui show</ansi> - Re-enables automatic Mudlet UI prompts when logging in

<ansi fg="subtitle">NOTES:</ansi>
<ansi fg="yellow-bold">Notes:</ansi>
- These commands only work if you are using a Mudlet client
- The UI package enhances your gameplay experience with custom windows and controls
- If the installation doesn't work automatically, check for prompts in your Mudlet client
Expand Down
Loading