You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ The [Mudlet Makers](https://github.com/Mudlet/Mudlet/graphs/contributors) could
104
104
105
105
<!-- ### One-Click Install Method
106
106
107
-
Copy/paste the following command into Mudlet's input line to install discMapper:
107
+
Copy/paste the following command into Mudlet's input line to install PRS:
108
108
109
109
```lua
110
110
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","https://github.com/iLPdev/prs/releases/download/v0.7.1/PRS.mpackage")
@@ -125,12 +125,16 @@ To install PRS, just follow these steps:
125
125
1. Drag and drop the file into your open Procedural Realms MUD profile.
126
126
1. Optionally, delete the .mpackage file from your computer.
127
127
128
+
### Initial Setup
129
+
130
+
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.
-[MDK](https://github.com/demonnic/MDK) provides EMCO and SUG support.
133
136
-[Mudlet][mudlet-url] MUD Client application must obviously be installed on your operating system (Windows, MacOS, and Linux)
137
+
-[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.
134
138
135
139
### Getting the Source
136
140
@@ -140,6 +144,23 @@ You can also clone the entire project directly with this command: `git clone git
140
144
141
145
**[^Top](#table-of-contents)**
142
146
147
+
<!-- USAGE -->
148
+
## Usage
149
+
150
+
### User Interface Configuration
151
+
152
+
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.
153
+
154
+
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.
155
+
156
+
### Command Line Interface
157
+
158
+
- 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.
159
+
160
+
-**@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.
0 commit comments