Mudlet

• Open-source MUD client for Windows, macOS and Linux.
• Uses Lua as a scripting language.

Resources

• Chocolatey package for Windows:

  choco install mudlet

Documentation

• Manual - for players
  • Introduction
  • User Interface

Scripting

• Geyser Layout Manager - an object oriented framework for creating, updating and organizing GUI elements within Mudlet
  • Use Mudlet’s UserWindows within Geyser
• Technical Manual
• Events
• Best Practices
• demonnic/muddler - a build tool for Mudlet packages
  • Edru2/DeMuddler - deconstructs mpackage files into Muddler projects
  • CI
• Mudlet Package Repository
• Vyzor Reference - an older UI framework that has largely been replaced by Geyser

GUI examples

• Midnight Sun
• Geyser UI Template

FAQ

Muddler project on Windows

1. Install Podman Desktop
2. Open PowerShell and navigate to the parent directory of the new project’s directory, e.g.

   mkdir $HOME/src
   cd $HOME/src

3. Create a new Muddler project in the “TemplateProject” folder:

   podman run --pull always --rm -it -v ${PWD}:/src -w /src demonnic/muddler --default

4. Rename the “TemplateProject” folder to something more appropriate, e.g.

   ren TemplateProject MyFirstMuddle

5. In Mudlet, create/open a profile that you use for development only, and install the Muddler package in order to facilitate automatic reloading of the package you are developing:

   lua installPackage("https://github.com/demonnic/muddler/releases/download/1.1.0/Muddler.mpackage")

6. Create a script in the Mudlet profile you use for development that uses Muddler to automatically reload the (development) package from its directory, e.g.

   local function killMDK()
     for pkgName, _ in pairs(package.loaded) do
       if pkgName:find("MDK") then
         debugc("Uncaching lua package " .. pkgName)
         package.loaded[pkgName] = nil
       end
     end
   end
   local function create_helper()
     if MDKhelper then MDKhelper:stop() end
     MDKhelper = Muddler:new({
       path = "C:/Users/USERNAME/src/MyFirstMuddle",
       postremove = killMDK,
     })
   end
    
   if not MDKhelper then
     registerAnonymousEventHandler("sysLoadEvent", create_helper)
   end

   • Make sure to use forward slashes (/) instead of backslashes (\) in the path
7. Watch for code changes and build continously:

   cd $HOME/src/MyFirstMuddle
   podman run --pull always --rm -it -v ${PWD}:/MyFirstMuddle -w /MyFirstMuddle demonnic/muddler -w

   • The package should now get installed in the Mudlet profile.
8. Edit the code using your favorite code editor.