Skip to content

docs(readme): add Usage #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iLPdev merged 2 commits into from
May 2, 2023
Merged

docs(readme): add Usage #69

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6b013c
docs(readme): add usage section
iLPdev Mar 21, 2023
47f0770
docs(readme): add Usage to TOC
iLPdev Mar 21, 2023
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
32 changes: 25 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

<!-- ### Vision

As complement to a planned Mudlet UI for Discworld MUD, the aim of this project is to provide existing and potential players with a newbie-friendly (accessible) and reliable means to map and navigate the Discworld MUD in an elegeant, modern MUD client. In line with that aim, the goal of this project is to release a Mudlet package with all the requisite aliases, triggers, and scripts. Ultimately, my hope is that discMapper might become a part of a larger Mudlet package for Discworld MUD, including guild-specific UI feature setss. -->

### 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
Expand Down Expand Up @@ -104,7 +101,7 @@ The [Mudlet Makers](https://github.com/Mudlet/Mudlet/graphs/contributors) could

<!-- ### One-Click Install Method

Copy/paste the following command into Mudlet's input line to install discMapper:
Copy/paste the following command into Mudlet's input line to install PRS:

```lua
lua function d(a,b)if not b:find("oci",1,true)then return end installPackage(b)os.remove(b)cecho("<lime_green>PRS package installed!\n")end registerAnonymousEventHandler("sysDownloadDone","d")downloadFile(getMudletHomeDir().."/oci.mpackage","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/iLPdev/prs/releases/download/v0.7.1/PRS.mpackage")
Expand All @@ -125,12 +122,16 @@ To install PRS, just follow these steps:
1. Drag and drop the file into your open Procedural Realms MUD profile.
1. Optionally, delete the .mpackage file from your computer.

### Initial Setup

Upon initial install, you will typically need to connect to the game server and resize the UI windows both horizontally and vertically to reveal their contents fully. See **[UI Configuration](#user-interface-configuration)** below.

### Dependencies

<a href="https://www.mudlet.org"><img src="https://www.mudlet.org/wp-content/uploads/2017/08/mudlet-wp-logo.png" alt="Mudlet" width="120" height="auto"></a>

- [MDK](https://github.com/demonnic/MDK) provides EMCO and SUG support.
- [Mudlet][mudlet-url] MUD Client application must obviously be installed on your operating system (Windows, MacOS, and Linux)
- [MDK](https://github.com/demonnic/MDK) provides EMCO and SUG support. The required code is already included in the PRS release package, requiring no additional download/install by the user.

### Getting the Source

Expand All @@ -140,6 +141,23 @@ You can also clone the entire project directly with this command: `git clone git

**[^Top](#table-of-contents)**

<!-- USAGE -->
## 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 `@<player name> <message>`. 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 -->
## Roadmap

Expand Down