Getting Started

Create a new story project with a single command:

npx @sharpee/sharpee init my-adventure
cd my-adventure
npm install

Build and play in your browser:

npx @sharpee/sharpee build
open dist/web/index.html

That's it. You have a running story.

What You Get

The starter project gives you a simple world with a couple of rooms and objects. From there, you build out your story by:

• Creating rooms and connecting them
• Adding objects with traits (openable, lockable, switchable, etc.)
• Writing the prose that brings it all to life

CLI Commands

Everything runs through npx @sharpee/sharpee:

• init <name> — Create a new story project
• init-browser — Add a browser client to an existing project
• build — Build your story bundle and browser client
• build-browser — Rebuild the browser client only
• ifid — Generate or validate an IFID

Next Steps

Try the tutorials to see how a real story comes together:

• Cloak of Darkness — The classic IF benchmark, step by step
• Family Zoo — A fuller example with multiple rooms and objects