Mudlet UI and Mapper support #369
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Help keywords for Mudlet and client-related commands | ||
| # These will be merged with the main keywords.yaml by the help system | ||
|
|
||
| help: | ||
| command: | ||
| information: | ||
| - client | ||
| - checkclient | ||
| - mudletmap | ||
| - mudletui | ||
|
|
||
| # Aliases for keywords when typing: help <keyword> | ||
| help-aliases: | ||
| mudletui: [mudlet, mudletgui, mudlet-ui, mudlet ui] | ||
| mudletmap: [mudlet-map, mudlet map] | ||
| checkclient: [client-check, clientcheck] | ||
| client: [clients, mud-client, mudclient] | ||
|
|
||
| # Command aliases for Mudlet-related commands | ||
| command-aliases: | ||
| mudletui: [mudlet, mgui] | ||
| mudletmap: [mudlet-map] | ||
| checkclient: [clientcheck] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # 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" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <ansi fg="black-bold">.:</ansi> <ansi fg="magenta">Help for </ansi><ansi fg="command">checkclient</ansi> | ||
|
|
||
| The <ansi fg="command">checkclient</ansi> command displays information about client-specific features available to you. | ||
|
|
||
| <ansi fg="yellow">Usage: </ansi> | ||
|
|
||
| <ansi fg="command">checkclient</ansi> - Shows details about detected client features and available enhancements | ||
|
|
||
| <ansi fg="subtitle">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 | ||
|
|
||
| <ansi fg="magenta-bold">See also:</ansi> <ansi fg="command">help mudletui</ansi>, <ansi fg="command">mudletmap</ansi> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| <ansi fg="black-bold">.:</ansi> <ansi fg="magenta">Help for </ansi><ansi fg="command">client</ansi> | ||
|
|
||
| This game supports various MUD clients with special features to enhance your gameplay experience. | ||
|
|
||
| <ansi fg="yellow">Supported Clients: </ansi> | ||
|
|
||
| <ansi fg="white-bold">Mudlet</ansi> - Full support with custom UI, mapping, and GMCP features | ||
| Use <ansi fg="command">help mudletui</ansi> and <ansi fg="command">help mudletmap</ansi> for more information. | ||
|
|
||
| <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> | ||
| - Character information and status updates | ||
| - Room and environment data | ||
| - Communication channels | ||
| - Party information | ||
| - Custom UI elements (Mudlet only) | ||
| - Client Mapping support (Mudlet only) | ||
|
|
||
| <ansi fg="magenta-bold">See also:</ansi> <ansi fg="command">help mudletui</ansi>, <ansi fg="command">help mudletmap</ansi>, <ansi fg="command">checkclient</ansi> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <ansi fg="black-bold">.:</ansi> <ansi fg="magenta">Help for </ansi><ansi fg="command">mudletmap</ansi> | ||
|
|
||
| The <ansi fg="command">mudletmap</ansi> command sends map data to Mudlet clients for enhanced navigation. | ||
|
|
||
| <ansi fg="yellow">Usage: </ansi> | ||
|
|
||
| <ansi fg="command">mudletmap</ansi> - Sends or refreshes map data to your Mudlet client | ||
|
|
||
| <ansi fg="subtitle">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 | ||
| - If your map isn't displaying properly, you can run this command to refresh it | ||
|
|
||
| <ansi fg="magenta-bold">See also:</ansi> <ansi fg="command">help mudletui</ansi>, <ansi fg="command">checkclient</ansi> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <ansi fg="black-bold">.:</ansi> <ansi fg="magenta">Help for </ansi><ansi fg="command">mudletui</ansi> | ||
|
|
||
| The <ansi fg="command">mudletui</ansi> command allows Mudlet client users to manage UI packages that enhance the gameplay experience. | ||
|
|
||
| <ansi fg="yellow">Usage: </ansi> | ||
|
|
||
| <ansi fg="command">mudletui</ansi> - Shows status information and available commands | ||
| <ansi fg="command">mudletui install</ansi> - Installs the GoMud UI package in your Mudlet client | ||
| <ansi fg="command">mudletui remove</ansi> - Removes the GoMud UI package from your Mudlet client | ||
| <ansi fg="command">mudletui update</ansi> - Manually check for updates to the GoMud UI package | ||
| <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> | ||
| - 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 | ||
| - You'll automatically see a message about this feature when you log in with Mudlet | ||
| - Using <ansi fg="command">mudletui hide</ansi> or <ansi fg="command">mudletui install</ansi> will hide the automatic prompts | ||
| - Using <ansi fg="command">mudletui show</ansi> will re-enable the automatic prompts | ||
| - Running <ansi fg="command">mudletui</ansi> without arguments shows current status and available commands | ||
|
|
||
| <ansi fg="magenta-bold">See also:</ansi> <ansi fg="command">help client</ansi>, <ansi fg="command">checkclient</ansi> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CONSIDER: A new category, instead of
information, we can useinterfaceor something - we can then put other stuff in there too, like the screenreader mode.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. I'll set that up 👍