Mudlet script for Procedural Realms MUD

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 correcly identifies rooms, stops creation of duplicate rooms, and accurately tracks your character's location on the map as you move about the realm. Additional convenience features include autosetting terrain colors, self-updating gauges for vitals, chat containers, and adjustable UI layout.

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

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

• v0.5.0 - Begin package installation devlopment
• v0.1.2 - Fixed exitstub tracking
• v0.2.1 - Fixed speedwalk

• Automatic GMCP mapping of Procedural Realms MUD
• Automatic GMCP room styling based on terrain.
  • Matches colors in PR's 'map' and 'look' quickmap.
• Tabbed Chat -- Adjustable, dockable, resizable, and no conversations lost in scroll!
• Self-updating gauges for charcater vitals, including Hit Points, Energy, Stamina, and eXperience Points.
• Speedwalking and pathfinding - Efficiently get where you're going - and fast!

• 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
• MDK is a collection of Lua 'classes' and modules by @demonnic
• Git is the version-control system for tracking changes and project management
• ImgBot provides GitHub-integrated image optimization

Version numbering approximates the Semantic Versioning approach.

• Project State: Prcedural Realms Script is under active development. The application can be used, but may be unstable. We are in need of beta testing prior to moving forward with the v1.0.0 release.

• Current Release: v0.11.0

^Top

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

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.

To 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 your open Procedural Realms MUD profile.
7. Optionally, delete the .mpackage file from your computer.

• MDK provides EMCO and SUG support.
• Mudlet MUD Client application must obviously be installed on your operating system (Windows, MacOS, and Linux)

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 [email protected]:iLPdev/prs.git

^Top

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.

Planned new features include:

See also the open issues for a list of proposed features (and known issues).

^Top

@Stack - Stop by and say hello on the Mudlet Discord Server!

^Top

• @demonnic for his seemingly indefatigable patience and help.
• @halimcme (Blizzard) for his Simple GMCP Mapper script and responsiveness to all my questions.
• README.md:
  • Best-README-Template for initial inspiration
  • Standard Readme specifcation
  • Shields.io for serving badges

^Top

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.

See the open issues for a list of ideas, questions, proposed features, and known issues.

There is not an explicit workflow requirement for this project, yet. I'm currently exprimenting with the Gitflow approach and Conventional Commits, but you don't need to.

Basically, to contribute to this project, you're invited to:

1. Create an Issue (bug report / feature request)
2. Fork the Repository
3. Create your Branch (optionally reference issue in branch name; git checkout -b feature/AmazingFeature)
4. Code Code Code
5. Commit your Changes (incrementally with detailed commit messages; git commit -m 'Add some AmazingFeature')
6. Push to your Branch (git push origin feature/AmazingFeature)
7. Submit a Pull Request

This project follows the Contributor Covenant Code of Conduct and operates under the W3C's Code of Ethics and Professional Conduct:

W3C is a growing and global community where participants choose to work together, and in that process experience differences in language, location, nationality, and experience. In such a diverse environment, misunderstandings and disagreements happen, which in most cases can be resolved informally. In rare cases, however, behavior can intimidate, harass, or otherwise disrupt one or more people in the community, which W3C will not tolerate.

A Code of Ethics and Professional Conduct is useful to define accepted and acceptable behaviors and to promote high standards of professional practice. It also provides a benchmark for self evaluation and acts as a vehicle for better identity of the organization.

The expectation is that our community group acts according to these guidelines, and that participants hold each other to these high standards. If you have any questions or are worried that the code isn't being followed, please contact the maintainer of this repository.

We following the all-contributors specification: Contributions of any kind are welcome!

Thanks go to these amazing folks (emoji key):

Stack 💻 🎨 📖 🚇 🚧 📆

^Top

Copyleft (2022) iLP development. Distributed under GPL v3.0-and-later. For more information, see LICENSE.

^Top