P

PlayMUD.online

Browser client documentation
Open Client Extend Docs

Overview

PlayMUD.online is a browser-based MUD client.

It connects your browser to MUD servers through the Go backend, renders ANSI terminal output, stores client settings in the server database, and provides modular tools for triggers, aliases, variables, hotkeys, Lua scripting, and status widgets.

What This Client Does

PlayMUD.online is meant to become a modern, persistent web client for MUDs. The browser handles the interface, while the server keeps settings and bridges traffic to the selected MUD. That means your trigger and alias configuration is designed to follow your profile rather than being trapped in one browser.

Mobile Client

Use the same profile, automation, scripts, and live MUD session through a terminal-first phone interface.

Terminal

ANSI colors, truecolor, clickable links, command history, charset selection, and quality-of-life input behavior.

MUD Servers

Choose bundled BatMUD targets, add other MUDs, and share or separate settings with numeric scopes.

Triggers

Match MUD output with contains, exact, or regex patterns, fire commands, capture regex groups, and highlight lines.

Aliases

Turn short commands into longer ones, including positional arguments such as $1 and $*.

Lua Aliases

Intercept typed commands with Lua, set variables, echo colored feedback, and send one or more MUD commands.

Lua Scripts

Write shared Lua helper functions, maintain temporary session state, and define status widgets from automation.

GMCP

Read structured MUD packages as nested Lua variables and react to live updates without parsing terminal text.

BatMUD Variables

Read BatMUD-specific vitals, party, target, effects, and mapper data through a read-only Lua table.

Status Widgets

Bind gauges and status values to state, then place them around the terminal or in the Status tab.

Variables

Use clear placeholders like {target} in commands, aliases, hotkeys, and trigger outputs.

Hotkeys

Capture browser key events or choose presets for function keys, numpad movement, and modifier shortcuts.

How Commands Flow

When you submit a command, PlayMUD.online expands it before sending it to the active MUD server.

  1. The command is accepted from the input box, a hotkey, or a trigger.
  2. Lua aliases may intercept typed commands first. If one matches, its script decides what to send.
  3. Simple aliases expand next, so k troll can become kill troll.
  4. Variables expand after aliases, so kill {target} can become kill orc.
  5. The final command is sent over the WebSocket to the backend, then to the selected MUD server.

See Lua Aliases, Aliases, and Variables for examples.

Current Philosophy

The simple UI is the easy mode, while sandboxed Lua powers advanced triggers, aliases, lifecycle scripts, temporary state, and status widgets. The trigger, alias, and variable panels remain useful friendly tools alongside that power layer.

Read the Lua roadmap for the planned direction.