Procedural Realms Script

<!-- PROJECT BANNER --> <div> <br /> <p align="left"> <a href=".github/images/prs-logo.png"> <img src=".github/images/prs-logo.png" alt="Procedural Realms Logo" width="auto" height="auto"> </a> </p> </div> <!-- PROJECT BADGES -->

[![Issues][issues-shield]][issues-url] ![Downloads][downloads-shield] [![GPL License][license-shield]][license-url] [![standard-readme compliant][standard-readme-shield]][standard-readme-url] <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- SHORT DESCRIPTION --> <p align="center"> Procedural Realms Script for Mudlet <br /> </p> <!-- LONG DESCRIPTION -->

The Procedural Realms Script [PRS] project gives Procedural Realms MUD players improved access to the advanced features of the Mudlet MUD client. By leveraging the specific "out of band" packets sent by Procedural Realms' server, PRS uses Mudlet's mapper to identify 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, self-updating gauges (vitals, combat, and skills), combat buttons and targetting, communication containers, quick slot buttons/keybindings, and a user-adjustable UI layout.

Project Link: [https://github.com/iLPdev/prs]<br /> Mudlet Forum Topic: [https://forums.mudlet.org/viewtopic.php?f=6&t=23126]

<!-- TABLE OF CONTENTS -->

Table of Contents

• Background
• Install
• Usage
• Roadmap
• Maintainer
• Acknowledgements
• Contributing
• License

<!-- ABOUT THE PROJECT -->

Background

<p> <!-- align="center"> --> <img src=".github/images/prs-screenshot-01.png" height="200" align="left"/> <img src=".github/images/prs-screenshot-tab-stats.png" height="200" align="float"/> <img src=".github/images/prs-screenshot-tell.png" height="200" align="float"/> </p>

History

Milestones

• v1.8.0 - Battle, Inventory, Quest, Skills, and ASCII Map tabs + Combat Buttons
• v1.7.0 - GUI (Adjustable Containers & Tabbed Windows) and Stats Tab
• v1.6.0 - Clickable URLs, EMCO Timestamps, and Revisionator Patching
• v1.5.0 - Auto-Install, Auto-Update, and Discord Rich Presence Integration
• v1.2.0 - EMCO Command Line Interface
• v1.1.0 - Management of Instanced Areas
• v1.0.0 - Dynamic Event-based Mapping Infrastructure
• v0.12.0 - Mini-Map Congruence
• v0.5.0 - Drag-and-Drop Package Installation

Features

• GUI with adjustable, dockable, and resizable tabbed windows.
• Automatic GMCP mapping of Procedural Realms MUD, including instanced areas/zones and terrain-based room styling.
• ASCII Map tab displays dynamic in-game 'map' command output in a tab!
• Tabbed Communications Channels with CLI -- No conversations lost in scroll!
• Battle and combat tabbed windows with dynamic skill/spell buttons and targeting!
• Character inventory parsing.
• Self-Updating Gauges for character vitals (HP, Energy, Spirit), Skills (Combat, Crafting, Artisan), and Combat (Target HP, Rage, Combo, etc).
• Speedwalking and pathfinding - Efficiently get where you're going - and fast!
• Slot Command Buttons & Keys - Carry out custom actions with the click of a button!
• Discord Rich Presence Integration
• Clickable URLs

Built With

• Lua is the programming language
• Edbee Library provides the text editor component for Mudlet
• Mudlet is a cross-platform, open source, and super fast MUD client
• Muddler is the tool that builds the package.
• MDK is a collection of Lua 'classes' and modules by @demonnic
• AdjustableTabWindow by @edru2 provides drag and drop tab support.
• Git is the version-control system for tracking changes and project management
• ImgBot provides GitHub-integrated image optimization

Versioning

Version numbering approximates the Semantic Versioning approach.

Project Status

<!-- 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. -->

[![Status Ventis][status-ventis]][andivionian-status-classifier]

• 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.

• Current Release: v1.8.0

^Top

<!-- GETTING STARTED -->

Install

The Mudlet Makers could not have made it easier to install preconfigured custom aliases, triggers, scripts, keybindings, and UIs.

Automatic Install Method

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.

Manual Install Method

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.

To manually install PRS, just follow these steps:

1. Locate the latest release of PRS.
2. Download the .mpackage file listed under Assets.
3. Open Mudlet on your operating system of choice.
4. Open an existing Procedural Realms MUD profile or create a new one.
5. Locate the saved file on your PC.
6. Drag and drop the file into the main display of your open Procedural Realms profile.
7. Optionally, delete the .mpackage file from your computer.

Initial Setup

Upon initial install and/or update, you may need to close and re-open your Procedural Realms profile and/or Mudlet. You will then typically need to connect to the game server, and configure the User Interface. See UI 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>

Aside from Mudlet, all the required dependencies are included in the PRS release package, requiring no additional download/install by the user.

• A modified AdjustableTabWindows is included for GUI management.
• [Mudlet][mudlet-url] MUD Client application must obviously be installed on your operating system (Windows, MacOS, and Linux)
• Included MDK modules provide EMCO, Revisionator, and SUG support.

Getting the Source

The PRS project is hosted on GitHub. All versions of the repository are available as releases.

You can also clone the entire project directly with this command: git clone git@github.com:iLPdev/prs.git

^Top

<!-- USAGE -->

Usage

User Interface Configuration

Upon initial intallation of PRS, there are six fully configurable adustable container 'windows' included by default: Four containers -- two attached to either side of the main display -- include various adjustable tab windows. The default tabs include the EMCO (communications tabs), Mudlet Mapper, Vitals (self-updating character status gauges), Statistics summarizing the in-game score command data, and a Combat tab with dynamic Combo and Rage gauges during battle. The remaining two windows are attached to the top and bottom of the main display. The default top window contains 12 buttons. Each button corresponds to the 12 in-game quick slots, and is bound to the F1 through F12 reflecting slots 1 through 0, -, and =. See the in-game help slot command for details on quick slots. <br /><br /> <img src=".github/images/prs-screenshot-unlocked.png" width="560" align="center"/>

<!-- 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. -->

1. Arrange Windows & Tabs: On initial usage, all six PRS windows are in their unlocked state as indicated by their bright green borders and titles. The adjustable containers and their tabs may be resized by dragging their borders, moved by click/dragging their window title/headings, as well as minimized or closed by clicking on their respective upper-right minimize/restore or close i