Table of Contents
Script API reference
Generated from smudgy v0.4.2-dev (smudgy-core.d.ts @ 5110ac599715, smudgy-mapper.d.ts @ 1a1183a3a230, smudgy-params.d.ts @ b7a128a7ff9c, smudgy-widgets.d.ts @ e96061b683ea)
Every function and type available to smudgy scripts.
Start with the manual
New to smudgy scripting? Write your first script, then read Modules and packages. The manual covers package publishing, permissions, shared data, widgets, maps, and structured MUD protocols.
API entries generated from the TypeScript contracts also appear as hover documentation in a TypeScript-aware editor.
Reading this reference
The reference is organized by module:
| Module | Covers |
|---|---|
smudgy:core | Sessions & settings · Command input · Lines & buffer · Shared state & events · Automations · Saved automations · Panes |
mapper (from smudgy:core) | The map: areas, rooms, exits, pathfinding |
smudgy:widgets | On-screen UI built from widget components |
smudgy:params | Install-time options for installed packages |
smudgy:state/gmcp | GMCP: structured data from the server (vitals, room, chat) |
smudgy:state/msdp | MSDP: experimental structured data from the server |
Runtime and guides
Scripts run on Deno with standard JavaScript, TypeScript, web APIs, Node.js built-ins, and registry imports. Availability inside a sandboxed package depends on its manifest. See Modules and packages and Permissions, sandboxing, and trust.