MUD Scripting directory
A technical directory of resources for MUD automation, client-side UI development, and server-side logic scripting including Lua, LPC, and Python frameworks.
Showing 10 of 10 entries
Mudlet Wiki Scripting Documentation
open-sourceComprehensive API reference for Mudlet's Lua implementation, covering event handling, trigger creation, and Geyser UI layout management.
Pros
- + Extensive documentation for event-based scripting
- + Specific examples for GMCP and MSDP data protocols
- + Active community-maintained updates
Cons
- − Can be overwhelming for beginners unfamiliar with Lua tables
- − Documentation for older functions occasionally conflicts with newer standards
TinTin++ Manual
open-sourceTechnical manual for the TinTin++ scripting language, focusing on action triggers, alias nesting, and session management.
Pros
- + High-performance regex engine documentation
- + Detailed explanation of variable scoping and lists
- + Low overhead for CLI environments
Cons
- − Steep learning curve for its proprietary syntax
- − Lacks built-in graphical UI framework
Geyser UI Framework
open-sourceAn object-oriented Lua framework built into Mudlet for creating complex graphical user interfaces, gauges, and mini-consoles.
Pros
- + Simplifies dynamic window resizing
- + Abstracts low-level TLabel and TConsole creation
- + Supports container nesting for modular UI design
Cons
- − Documentation on style sheets (CSS) is sparse
- − Significant performance hit if not optimized for high-frequency updates
Regex101
freeEssential tool for testing and debugging PCRE and Python regular expressions used in MUD triggers.
Pros
- + Real-time explanation of regex tokens
- + Supports PCRE, which is the standard for most MUD clients
- + Library of community regex patterns
Cons
- − General tool, not specific to MUD color codes/ANSI
- − Requires manual copy-paste from client logs
Lua 5.1 Reference Manual
freeThe official specification for the Lua version most commonly embedded in MUD clients like Mudlet and MUSHclient.
Pros
- + Definitive source for table manipulation and string patterns
- + Explains metamethods and environment scoping
- + Crucial for debugging logic errors outside client-specific APIs
Cons
- − Highly technical and academic language
- − Does not cover client-specific library extensions
Mudlet Development Kit (MDK)
open-sourceA collection of Lua modules for Mudlet designed to simplify common tasks like logging, profiling, and advanced event management.
Pros
- + Provides a standardized logging framework
- + Includes a flexible 'Timer' class for complex sequencing
- + Maintained by high-profile community developers
Cons
- − Adds a dependency layer to distributed script packages
- − Requires familiarity with GitHub for updates
LuaUnit
open-sourceA unit testing framework for Lua that can be used to test complex MUD script logic offline.
Pros
- + Allows testing of script logic without connecting to a MUD
- + Supports standard xUnit reporting
- + Compatible with Lua 5.1 used in clients
Cons
- − Requires mocking client-specific functions (e.g., send, echo)
- − Overhead may be too high for simple trigger scripts
Mudlet-Package-Manager
open-sourceA framework for distributing and auto-updating Lua script packages for Mudlet users.
Pros
- + Enables version control for distributed scripts
- + Simplifies user installation of complex plugins
- + Supports dependency management
Cons
- − Requires developers to maintain a specific JSON manifest
- − Client support for auto-updates can be finicky
MUSHclient Lua API Documentation
freeTechnical reference for all internal functions available to the Lua scripting engine within MUSHclient.
Pros
- + Detailed function signatures
- + Specific examples for every API call
- + Covers trigger, alias, and timer manipulation
Cons
- − Requires basic Lua knowledge to navigate
- − Single-page layout is very long
LPC Wiki
freeA community-maintained wiki documenting LPC syntax, driver-specific efuns, and common mudlib implementation patterns.
Pros
- + Central repository for syntax reference
- + Includes comparisons between driver versions
- + Crowdsourced examples
Cons
- − Some sections are incomplete or outdated
.