@sharpee/sharpee 1.0.8 → 1.1.1

package/README.md

@@ -7,10 +7,22 @@ A modern TypeScript interactive fiction engine for creating text adventures and
 
 ## Installation
 
+Add the runtime library to a project that embeds the engine:
+
 ```bash
 npm install @sharpee/sharpee
 ```
 
+To scaffold and build a story from the command line, install the devkit globally —
+it provides the `sharpee` CLI:
+
+```bash
+npm install -g @sharpee/devkit
+# then
+sharpee init my-story
+sharpee build
+```
+
 ## Features
 
 - **Event-Driven Architecture** - Immutable events for all state changes
@@ -24,59 +36,44 @@ npm install @sharpee/sharpee
 ```typescript
 import {
   GameEngine,
-  WorldModel,
   EnglishParser,
-  EnglishLanguageProvider,
-  TextService
+  EnglishLanguageProvider
 } from '@sharpee/sharpee';
 
-// Define your story
-const story = {
-  metadata: {
-    title: 'My Adventure',
-    author: 'Your Name',
-    version: '1.0.0'
-  },
-
-  setup(world: WorldModel) {
-    // Create a room
-    const room = world.createEntity('room', {
-      id: 'start-room',
-      name: 'Starting Room',
-      description: 'You are in a small room with stone walls.'
-    });
-
-    // Set as starting location
-    world.setStartingLocation(room);
-  }
-};
-
-// Initialize the engine
-const engine = new GameEngine({
-  story,
-  parser: new EnglishParser(),
-  languageProvider: new EnglishLanguageProvider(),
-  textService: new TextService()
-});
-
-// Start the game
-const startEvents = engine.start();
+// Set up language + parser
+const language = new EnglishLanguageProvider();
+const parser = new EnglishParser(language);
+
+// Build the engine (world and player typically come from your story setup)
+const engine = new GameEngine({ world, player, parser, language });
+
+// Register the story, then start
+engine.setStory(story);
+engine.start();
 
 // Process player commands
-const events = engine.processCommand('look');
+const result = await engine.executeTurn('look');
 ```
 
+> Rendering is no longer a separate text service (ADR-174). The engine's prose
+> pipeline produces `ITextBlock[]` that are carried to the UI by channels
+> (ADR-163); use `renderToString` to flatten blocks for a plain-text host.
+
 ## What's Included
 
-This package re-exports the core Sharpee packages:
+This umbrella package re-exports the **story runtime baseline** — the imports a
+story author needs (ADR-178). It deliberately does **not** re-export every
+symbol from every sub-package; for advanced use, import the specific sub-package
+directly (e.g. `@sharpee/world-model`, `@sharpee/stdlib`).
 
 | Export | Description |
 |--------|-------------|
 | `GameEngine` | Main game runtime |
-| `WorldModel`, `IFEntity` | Entity and world management |
+| `WorldModel`, `IFEntity`, `TraitType` | Entity and world management (types) |
 | `EnglishParser` | Natural language command parser |
-| `EnglishLanguageProvider` | English text generation |
-| `TextService` | Text formatting and output |
+| `EnglishLanguageProvider` | English language provider |
+| `renderToString`, `renderStatusLine` | Flatten prose blocks for a text host |
+| `ITextBlock`, `IDecoration` | Prose-pipeline output types (ADR-096) |
 | `QueryManager` | Player input queries (yes/no, menus) |
 
 ## Standard Actions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sharpee/sharpee",
-  "version": "1.0.8",
+  "version": "1.1.1",
   "description": "Sharpee - Interactive Fiction Engine for TypeScript",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -12,26 +12,26 @@
     }
   },
   "dependencies": {
-    "@sharpee/channel-service": "^1.0.8",
-    "@sharpee/core": "^1.0.8",
-    "@sharpee/engine": "^1.0.8",
-    "@sharpee/event-processor": "^1.0.8",
-    "@sharpee/ext-testing": "^1.0.8",
-    "@sharpee/if-domain": "^1.0.8",
-    "@sharpee/if-services": "^1.0.8",
-    "@sharpee/lang-en-us": "^1.0.8",
-    "@sharpee/media": "^1.0.8",
-    "@sharpee/parser-en-us": "^1.0.8",
-    "@sharpee/platform-browser": "^1.0.8",
-    "@sharpee/plugin-npc": "^1.0.8",
-    "@sharpee/plugin-scheduler": "^1.0.8",
-    "@sharpee/plugin-state-machine": "^1.0.8",
-    "@sharpee/plugins": "^1.0.8",
-    "@sharpee/character": "^1.0.8",
-    "@sharpee/story-runtime-baseline": "^1.0.8",
-    "@sharpee/stdlib": "^1.0.8",
-    "@sharpee/text-blocks": "^1.0.8",
-    "@sharpee/world-model": "^1.0.8"
+    "@sharpee/channel-service": "^1.1.1",
+    "@sharpee/core": "^1.1.1",
+    "@sharpee/engine": "^1.1.1",
+    "@sharpee/event-processor": "^1.1.1",
+    "@sharpee/ext-testing": "^1.1.1",
+    "@sharpee/if-domain": "^1.1.1",
+    "@sharpee/if-services": "^1.1.1",
+    "@sharpee/lang-en-us": "^1.1.1",
+    "@sharpee/media": "^1.1.1",
+    "@sharpee/parser-en-us": "^1.1.1",
+    "@sharpee/platform-browser": "^1.1.1",
+    "@sharpee/plugin-npc": "^1.1.1",
+    "@sharpee/plugin-scheduler": "^1.1.1",
+    "@sharpee/plugin-state-machine": "^1.1.1",
+    "@sharpee/plugins": "^1.1.1",
+    "@sharpee/character": "^1.1.1",
+    "@sharpee/story-runtime-baseline": "^1.1.1",
+    "@sharpee/stdlib": "^1.1.1",
+    "@sharpee/text-blocks": "^1.1.1",
+    "@sharpee/world-model": "^1.1.1"
   },
   "keywords": [
     "interactive-fiction",