Smudgy manual

This manual begins with connecting and playing. Later sections cover automation, mapping, packages, and scripting. You do not need to know how to program to use the first four sections.

If you have not installed smudgy yet, start with Install and update smudgy. Otherwise, continue with Connect to a MUD.

• Install and update smudgy — choose the official Windows, macOS, or Linux build and keep it current.
• Connect to a MUD — add a server and profile, then open your first session.
• Find your way around — output, command input, toolbar, panes, and tool windows.
• Make smudgy comfortable to use — font, colors, wrapping, input behavior, and logging.
• Use a cloud account — sign in, verify your email, manage sessions, and understand what is optional.

• Enter commands efficiently — history, completion, separators, and password masking.
• Manage sessions and profiles — reconnect, play offline, and keep characters separate.
• Keep a session log — find readable logs and capture raw connection data when diagnosing a problem.

• Choose an automation — aliases, triggers, and hotkeys in plain language.
• Create an alias — turn a short command into one or more game commands.
• Create triggers and hotkeys — react to game text or a key press.
• Organize and troubleshoot automations — folders, enabled state, matching, and errors.

• Use the map while playing — location, routes, speedwalks, and disabled areas.
• Edit a map — areas, rooms, exits, labels, shapes, and undo.
• Share maps safely — copies, permissions, secrets, and ownership.

• Find and install packages — discovery, install options, and enablement.
• Review package access and updates — sandbox permissions, changed requests, trust, and removal.

These guides assume some familiarity with JavaScript or TypeScript. The script API reference gives the exact signatures and types.

• Write your first script
• Choose between modules and packages
• Write and publish a package
• Declare package permissions
• Share state, events, and procedures
• Build on-screen widgets
• Add controls and tables to a widget
• Draw and animate a canvas
• Work with maps from a script
• Read GMCP and MSDP

• Troubleshooting — connection, display, automation, map, and package checks.
• Data files and backups — what smudgy stores and what to copy before experimenting.
• Glossary — the words used by smudgy, MUDs, and this manual.

• Script API reference — every smudgy-specific function and type available to scripts.