A development cli tool used to build, test, and deploy room scripts for Mucklet.com realms, creating textual worlds of roleplay.

Quick start

Install NodeJS, and run the following commands:

npx mucklet-script init myproject
cd myproject
npm install
npm run build

Usage

For full usage, run:

npx mucklet-script

Documentation

• Configuration
• Mucklet Script Documentation

Guides

• Writing scripts - Custom commands

Script examples

Script file | Description --- | --- ambience.ts | A script showing ambient descriptions with random time intervals. day_and_night.ts | A script cycling between a "day" and "night" room profile based on real time. intercom_inside.ts | An intercom script allowing communication with another room running the intercom_outside.ts script. intercom_outside.ts | An intercom script allowing communication with another room running the intercom_inside.ts script. lock_inside.ts | A script that locks a door preventing others from using an exit in the room running the lock_outside.ts script. lock_outside.ts | A script that prevents characters from using an exit locked by the lock_inside.ts script. secret_exit.ts | A script that reveals a secret passage when the password "tapeworm" is spoken. vip_list.ts | A script that manages a list of VIP characters, requested by another room running the vip_guard.ts script. vip_guard.ts | A script that prevents characters from using an exit unless they are listed as VIP character by the vip_list.ts script.

About

The mucklet-script cli tool lets you:

• create and initialize new script projects
• build and test scripts
• deploy scripts to a Mucklet realm
• fetch and display script console logs

See the Mucklet Script Documentation for guides, examples, and API references.