UrsaMU Guides

This section contains comprehensive guides and tutorials to help you get started
with UrsaMU, whether you’re installing it for the first time, learning how to
use it as a player, or administering your own server.

Installation Guide

Learn how to install and set up UrsaMU on your system:

• Prerequisites
• Installation Methods
• Configuration
• Running the Server

User Guide

Learn how to use UrsaMU as a player:

• Getting Started
• Basic Commands
• Character Creation
• Communication

Admin Guide

Learn how to administer an UrsaMU server:

• User Management
• Server Configuration
• Backup and Restore
• Troubleshooting

Scripting Guide

Write TypeScript/JS scripts that run in the sandboxed SDK:

• How scripting works
• The SDK (u)
• Writing a script
• Testing scripts

MUSH Compatibility

Coming from PennMUSH, TinyMUSH, or MUX2? See what works today and what’s planned:

• What works today
• What’s different
• Planned enhancements
• Connecting with MU* clients

Docker

Run UrsaMU in a container:

• Quick start
• docker-compose.yaml reference
• Environment & volumes
• Behind a reverse proxy
• Troubleshooting

Production Deployment

Get UrsaMU running reliably in production:

• Environment variables
• Daemon mode
• systemd service
• Nginx + TLS
• Firewall & log rotation

Scenes

Create, write in, and export collaborative roleplay logs:

• Creating a scene
• Writing poses
• Private scenes & invitations
• Exporting a scene
• Full API reference

Wiki

Build and manage your game wiki with file-based Markdown:

• Directory structure
• Frontmatter
• In-game commands
• REST API
• Hooks

Writing Help Files

Create and organize in-game help files for your players:

• Directory structure
• File naming conventions
• Markdown support & tables
• How players access help

Password Reset

How admins generate reset tokens and players consume them:

• Admin steps
• Player steps & API
• Error responses

Lock Expressions

Control access to commands, exits, and objects with lock expressions:

• Flag checks
• Boolean operators
• Attribute checks
• Using locks in scripts

Customization

Learn how to customize your UrsaMU server:

• Themes
• Commands
• Game Mechanics
• Integration