Skip to content

Commit 45b11f5

Browse files
committed
docs(readme): 📝 update Milestones, Install, and Usage
1 parent e2dea3b commit 45b11f5

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
<!-- SHORT DESCRIPTION -->
2121
<p align="center">
22-
Mudlet script for Procedural Realms MUD
22+
Mudlet UI for Procedural Realms MUD
2323
<br />
2424
</p>
2525

@@ -56,6 +56,7 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]
5656

5757
#### Milestones
5858

59+
- v1.5.0 - Auto-Install, Auto-Update, and Discord Rich Presence Integration
5960
- v1.2.0 - EMCO Command Line Interface
6061
- v1.1.0 - Management of Instanced Areas
6162
- v1.0.0 - Dynamic Event-based Mapping Infrastructure
@@ -69,6 +70,7 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]
6970
- Tabbed Communications Channels with CLI -- Adjustable, dockable, resizable, and no conversations lost in scroll!
7071
- Self-Updating Gauges for character vitals, including Hit Points, Energy, Stamina, Rage, Combo, and eXperience Points.
7172
- Speedwalking and pathfinding - Efficiently get where you're going - and fast!
73+
- Discord Rich Presence integration
7274

7375
### Built With
7476

@@ -90,7 +92,7 @@ Version numbering approximates the [Semantic Versioning](http://semver.org) appr
9092

9193
- **Project State**: Procedural Realms Script is under active development. The application can be used, but may be unstable. We are in need of continued testing prior to moving forward with each new release.
9294

93-
- **Current Release**: v1.4.1
95+
- **Current Release**: v1.5.0
9496

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

@@ -99,32 +101,27 @@ Version numbering approximates the [Semantic Versioning](http://semver.org) appr
99101

100102
The [Mudlet Makers](https://github.com/Mudlet/Mudlet/graphs/contributors) could not have made it easier to install preconfigured custom aliases, triggers, scripts, keybindings, and UIs.
101103

102-
<!-- ### One-Click Install Method
104+
### Automatic Install Method
103105

104-
Copy/paste the following command into Mudlet's input line to install PRS:
106+
Procedural Realms MUD will automatically detect that you've connected to the server via Mudlet and prompt you to install or update to the latest version of PRS by issuing the `mudlet install` command. You may then close and restart Mudlet to initialize the latest version of PRS. See the in-game `mudlet help` command for details.
105107

106-
```lua
107-
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")
108-
```
109-
-->
108+
### Manual Install Method
110109

111-
### Package Install Method
110+
Just like any other package as of Mudlet v4.8+, you may install PRS by simply dragging and droppping the package file into Mudlet. PRS will then be merged into your active Mudlet profile, and you may delete the original file.
112111

113-
Just like any other package as of Mudlet v4.8+, you may install PRS by simply dragging and droppping the package file into Mudlet. discMapper will then be merged into your active Mudlet profile, and you may delete the original file.
114-
115-
To install PRS, just follow these steps:
112+
To manually install PRS, just follow these steps:
116113

117114
1. Locate the [latest release](https://github.com/iLPdev/prs/releases/latest) of PRS.
118115
1. Download the .mpackage file listed under Assets.
119116
1. Open Mudlet on your operating system of choice.
120117
1. Open an existing Procedural Realms MUD profile or create a new one.
121118
1. Locate the saved file on your PC.
122-
1. Drag and drop the file into your open Procedural Realms MUD profile.
119+
1. Drag and drop the file into the main display of your open Procedural Realms profile.
123120
1. Optionally, delete the .mpackage file from your computer.
124121

125122
### Initial Setup
126123

127-
Upon initial install, you will typically need to connect to the game server, enable GMCP options, and resize the UI windows both horizontally and vertically to reveal their contents fully. See **[UI Configuration](#user-interface-configuration)** below.
124+
Upon initial install and/or update, you may need to close and re-open your Procedural Realms profile in Mudlet. You will then 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.
128125

129126
### Dependencies
130127

@@ -148,8 +145,9 @@ You can also clone the entire project directly with this command: `git clone git
148145

149146
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.
150147

151-
1. **Enable GMCP**: You must enable GMCP options on the game server. To determine if GMCP in enabled on the server, log into the game and issue the following command: `config gmcp`. Displayed under the "Terminal" column are the "gmcp" and "gmcpseenrooms" options. If they are not currently set to "on", you may enable them by issuing the `gmcp` and `gmcpseenroom` commands.
152-
3. **Resize Windows**: 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. You can optionally drag, re-arrange, pop out, and otherwise move the windows to your liking,
148+
<!-- 1. **Enable GMCP**: You must enable GMCP options on the game server. To determine if GMCP in enabled on the server, log into the game and issue the following command: `config gmcp`. Displayed under the "Terminal" column are the "gmcp" and "gmcpseenrooms" options. If they are not currently set to "on", you may enable them by issuing the `gmcp` and `gmcpseenroom` commands. -->
149+
1. **Resize Windows**: 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.
150+
2. **Layout Preferences: You can optionally drag, re-arrange, pop out, and otherwise move the two PRS windows to your liking.
153151

154152
### Command Line Interface
155153

0 commit comments

Comments
 (0)