Getting Started

Sharpee is a command-line tool. Install it once, globally:

npm install -g @sharpee/devkit

That gives you the sharpee command. Create a new story project:

sharpee init my-adventure
cd my-adventure
npm install

Add the browser client, then build and play:

sharpee init-browser
npm install
sharpee build
python3 -m http.server -d dist/web

Open http://localhost:8000 and you have a running story. (Any static file server works; the build also emits dist/my-adventure.sharpee, the portable story bundle.)

What You Get

The starter project gives you a small working world. 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 the sharpee command:

• 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 --test — Build, then replay your transcript tests
• build-browser — Rebuild the browser client only
• compose <file.story> — Compile a Chord story and run its load-time checks
• introspect — Print the project's rooms, objects, and NPCs as JSON
• ifid — Generate or validate an IFID
• register / list — Name a story's location so build works from anywhere

Next Steps

The main tutorial is The Sharpee Book (v2.0.0): it builds one complete game, the Family Zoo, across 31 chapters, from this same sharpee init to a themed, tested browser release. Also available:

• Cloak of Darkness — The classic IF benchmark, step by step
• Family Zoo — The book's game, with a legacy 17-step web tutorial
• The Chord Language — New in 3.0: write your story as a .story file instead of TypeScript