From e6b013cc4ae2e8bc71cb9f685732ecab54e219ca Mon Sep 17 00:00:00 2001 From: iLPdev Date: Tue, 21 Mar 2023 09:18:03 -0700 Subject: [PATCH 1/2] docs(readme): add usage section --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 619fcb9..2da0c93 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ The [Mudlet Makers](https://github.com/Mudlet/Mudlet/graphs/contributors) could +## Usage + +### User Interface Configuration + +There are two fully configurable UI elements that are currently included in PRS by default: the EMCO (Communications Tabs and Map) and the Vitals (character Stat guages) windows. The UI windows are docked on the right of mudlet's main display upon connection to the game server. The windows may be resized by dragging their borders, moved by click/dragging their window title/headings, as well as undocked or closed by clicking on their respective upper-right pop-out or close icons. + +On initial usage, you will typically need to resize the windows both horizontally and vertically to reveal their contents fully. Note that the window configurations are preserved but not restored until connection to the game server has been established. + +### Command Line Interface + +- A command line interface exists at the bottom of the `Chat`, `Newbie`, `Trade`, and `Local` tabs within the EMCO window. To communicate through any of these channels, simply click on the empty bottom line of the tab and input your text to be sent through the corresponding communication channel. + +- **@tell** - You may communicate privately with another player via the game's `tell` command from within any of the EMCO communication tabs' CLI via `@ `. For example, entering `@stack blah foo` into a tab's CLI will issue `tell stack blah foo` to the game server. + +**[^Top](#table-of-contents)** + ## Roadmap From 47f0770041bb7097361d989fc598421b9816a67c Mon Sep 17 00:00:00 2001 From: iLPdev Date: Tue, 21 Mar 2023 09:24:56 -0700 Subject: [PATCH 2/2] docs(readme): add Usage to TOC --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2da0c93..be3a56a 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126] - [Background](#background) - [Install](#install) +- [Usage](#usage) - [Roadmap](#roadmap) - [Maintainer](#maintainer) - [Acknowledgements](#acknowledgements) @@ -61,16 +62,12 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126] - v0.12.0 - Mini-Map Congruence - v0.5.0 - Drag-and-Drop Package Installation - - ### Features - Automatic GMCP mapping of Procedural Realms MUD, including instanced areas/zones. - Automatic GMCP room styling based on terrain to matches colors in PR's 'map' and 'look' quickmap. - Tabbed Communications Channels with CLI -- Adjustable, dockable, resizable, and no conversations lost in scroll! -- Self-updating gauges for character vitals, including Hit Points, Energy, Stamina, Rage, Combo, and eXperience Points. +- Self-Updating Gauges for character vitals, including Hit Points, Energy, Stamina, Rage, Combo, and eXperience Points. - Speedwalking and pathfinding - Efficiently get where you're going - and fast! ### Built With