UrsaMU Guides

User guides and tutorials for UrsaMU v2.6.0 — installation, day-to-day play,
admin operations, plugin development, and softcoding.

Getting Started

• Installation — Prerequisites, install methods,
  first-run setup, and connecting.
• User Guide — Connecting and playing as a player.
• CLI Reference — ursamu create, plugin, update, scripts.

Operating a Server

• Admin Guide — Permissions, user management,
  configuration, @reload, plugin install behavior, security.
• Production Deployment — .env and JWT_SECRET,
  scripts/daemon.sh, systemd, nginx + TLS, log rotation, updates.
• Docker — Containerized deployment with docker compose.
• Password Reset — Admin tokens, player flow,
  REST API.
• Debugging — Common runtime errors and how to fix them.

Customizing the Game

• Customization — Color codes, custom commands,
  attributes, plugins, REST routes, format handlers, external integrations.
• Lock Expressions — Lockfunc syntax, boolean
  operators, custom lockfuncs via registerLockFunc.
• Command Reference — All built-in commands.
• Help Authoring — Writing help files, directory
  structure, conventions.

Writing Code

• Softcode (TinyMUX) — Pure MUX softcode: think,
  substitutions, functions, @switch/@dolist, $/^ patterns, UDFs.
• Attribute Scripts — TypeScript on object
  attributes via @trigger, u.trigger, u.eval.
• Scripting (TypeScript) — File sandbox, the u SDK,
  ESM vs legacy blocks, aliases and switches.
• Build Your First Script — Step-by-step walkthrough.
• SDK Cookbook — Every u.* namespace with examples.
• Recipes — Copy-paste patterns for common tasks.
• Game Clock — u.sys.gameTime and the in-game calendar.

Game Systems

• Scenes — Collaborative RP logs: create, pose, export.
• Wiki — File-based Markdown wiki with frontmatter and REST.

MUSH Compatibility

Coming from PennMUSH, TinyMUSH, or MUX2? See
mush compatibility for what works today, what
differs, and how to connect with traditional MU* clients.