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
[](https://github.com/iLPdev/prs/releases/latest)[![Issues][issues-shield]][issues-url][![GPL License][license-shield]][license-url][![standard-readme compliant][standard-readme-shield]][standard-readme-url]
16
-
[](https://github.com/Mudlet/Mudlet/releases/latest)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[](https://github.com/iLPdev/prs/releases/latest)[![Issues][issues-shield]][issues-url]![Downloads][downloads-shield][![GPL License][license-shield]][license-url][![standard-readme compliant][standard-readme-shield]][standard-readme-url]
16
+
[](https://github.com/Mudlet/Mudlet/releases/latest)<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --><!-- ALL-CONTRIBUTORS-BADGE:END -->
The Procedural Realms Script [PRS] project gives [Procedural Realms MUD](http://textdimension.com/) players improved access to the advanced features of the [Mudlet](https://www.mudlet.org) MUD client. By leveraging the specific "out of band" packets sent by Procedural Realms' server, PRS uses Mudlet's mapper to identifies rooms/exits, prevent creation of duplicate rooms/areas, manage instanced areas, and accurately track your character's location on the map as you move about the realm. Additional convenience features include speedwalking/pathfinding, autosetting map terrain colors, self-updating gauges for vitals, communication containers, and a user-adjustable UI layout.
Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]
31
31
32
-
33
32
<!-- TABLE OF CONTENTS -->
33
+
34
34
## Table of Contents
35
35
36
36
-[Background](#background)
37
37
-[Install](#install)
38
38
-[Usage](#usage)
39
-
-[Roadmap](#roadmap)
39
+
-[Roadmap](#roadmap)
40
40
-[Maintainer](#maintainer)
41
41
-[Acknowledgements](#acknowledgements)
42
42
-[Contributing](#contributing)
43
43
-[License](#license)
44
-
44
+
45
45
<!-- ABOUT THE PROJECT -->
46
+
46
47
## Background
47
48
48
49
<p> <!-- align="center"> -->
@@ -71,6 +72,7 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]
71
72
- Self-Updating Gauges for character vitals, including Hit Points, Energy, Stamina, Rage, Combo, and eXperience Points.
72
73
- Speedwalking and pathfinding - Efficiently get where you're going - and fast!
73
74
- Discord Rich Presence integration
75
+
- Clickable URLs
74
76
75
77
### Built With
76
78
@@ -86,24 +88,26 @@ Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]
86
88
Version numbering approximates the [Semantic Versioning](http://semver.org) approach.
87
89
88
90
### Project Status
91
+
89
92
<!-- Describe the current release and any notes about the current state of the project. Examples: currently compiles on your host machine, but is not cross-compiling for ARM, APIs are not set, feature not implemented, etc. -->
-**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.
94
97
95
-
-**Current Release**: v1.5.0
98
+
-**Current Release**: v1.6.0
96
99
97
100
**[^Top](#table-of-contents)**
98
101
99
102
<!-- GETTING STARTED -->
103
+
100
104
## Install
101
105
102
106
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.
103
107
104
108
### Automatic Install Method
105
109
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.
110
+
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.
107
111
108
112
### Manual Install Method
109
113
@@ -139,25 +143,28 @@ You can also clone the entire project directly with this command: `git clone git
139
143
**[^Top](#table-of-contents)**
140
144
141
145
<!-- USAGE -->
146
+
142
147
## Usage
143
148
144
149
### User Interface Configuration
145
150
146
151
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.
147
152
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.
153
+
<!-- 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. -->
154
+
155
+
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.
156
+
2.**Layout Preferences:** You can optionally drag, re-arrange, pop out, and otherwise move the two PRS windows to your liking.
151
157
152
158
### Command Line Interface
153
159
154
160
- 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.
155
161
156
-
-**@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.
162
+
-**@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.
157
163
158
164
**[^Top](#table-of-contents)**
159
165
160
166
<!-- ROADMAP -->
167
+
161
168
## Roadmap
162
169
163
170
The primary objective is to develop and test a minimally viable package for Mudlet that meets the requirements for includion on the list of connectable games when Mudlet starts and, in turn, to increase the playerbase of Procedural Realms.
@@ -169,13 +176,15 @@ See also the [open issues](https://github.com/iLPdev/prs/issues) for a list of p
169
176
**[^Top](#table-of-contents)**
170
177
171
178
<!-- MAINTAINER(S) -->
179
+
172
180
## Maintainer
173
181
174
-
[@Stack](https://github.com/iLPdev) - Stop by and say hello on the [Procedural Realms Discord Server]([https://discordapp.com/invite/kuYvMQ9](https://discord.gg/rRFEjc6vV9))!
182
+
[@Stack](https://github.com/iLPdev) - Stop by and say hello on the [Procedural Realms Discord Server](<[https://discordapp.com/invite/kuYvMQ9](https://discord.gg/rRFEjc6vV9)>)!
175
183
176
184
**[^Top](#table-of-contents)**
177
185
178
186
<!-- ACKNOWLEDGEMENTS -->
187
+
179
188
## Acknowledgements
180
189
181
190
<!-- State anyone or anything that significantly helped with the development of your project.
@@ -193,9 +202,10 @@ See also the [open issues](https://github.com/iLPdev/prs/issues) for a list of p
193
202
**[^Top](#table-of-contents)**
194
203
195
204
<!-- CONTRIBUTING -->
205
+
196
206
## Contributing
197
207
198
-
Contributions are what make the open source community such an amazing space to be learn, inspire, and create. Any contributions you make are **greatly appreciated** -- that’s the main reason discMapper is open-sourced! There are so many ways to contribute, even if you’re not a technical person. All contributions--no matter how small---are always welcome.
208
+
Contributions are what make the open source community such an amazing space to be learn, inspire, and create. Any contributions you make are **greatly appreciated** -- that’s the main reason discMapper is open-sourced! There are so many ways to contribute, even if you’re not a technical person. All contributions--no matter how small---are always welcome.
199
209
200
210
See the [open issues](https://github.com/iLPdev/prs/issues) for a list of ideas, questions, proposed features, and known issues.
201
211
@@ -257,6 +267,7 @@ Thanks go to these amazing folks ([emoji key](https://allcontributors.org/docs/e
257
267
**[^Top](#table-of-contents)**
258
268
259
269
<!-- LICENSE -- Must be last section. -->
270
+
260
271
## License
261
272
262
273
Copyleft (2023) _iLP development_. Distributed under GPL v3.0-and-later. For more
@@ -266,6 +277,7 @@ information, see [`LICENSE`](https://github.com/iLPdev/prs/blob/main/LICENSE).
0 commit comments