@ai-rpg-engine/starter-fantasy 1.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +31 -16
  2. package/package.json +5 -1
package/README.md CHANGED
@@ -18,30 +18,45 @@
18
18
  npm install @ai-rpg-engine/starter-fantasy
19
19
  ```
20
20
 
21
- ## What's Inside
21
+ ## What You'll Learn
22
+
23
+ This starter demonstrates the full engine stack in a compact world:
24
+
25
+ | Feature | What the Chapel shows |
26
+ |---|---|
27
+ | **Rulesets** | `fantasyMinimalRuleset` — stats (vigor/instinct/will), resources (hp/stamina), verbs, formulas |
28
+ | **Zones & traversal** | 5 zones across 2 rooms with adjacency, light levels, interactables, hazards |
29
+ | **Districts** | Chapel Grounds (sacred) vs Crypt Depths (cursed, faction-controlled) |
30
+ | **Dialogue** | Branching pilgrim conversation with 3 paths and global-flag effects |
31
+ | **Combat** | Ash Ghoul with aggressive AI profile, fear tags, guard goal |
32
+ | **Cognition & perception** | Memory decay, perception filter, undead presentation rule |
33
+ | **Progression** | 3-node Combat Mastery tree with XP rewards on entity defeat |
34
+ | **Environment** | Unstable-floor hazard draining stamina on zone entry |
35
+ | **Factions** | Chapel-undead faction with cohesion setting |
36
+ | **Belief provenance** | Rumor propagation with delay, belief tracking |
37
+ | **Inventory** | Healing draught with scripted item-use effect |
38
+ | **Simulation inspector** | Full inspection wired for replay analysis |
22
39
 
23
- A complete content pack featuring:
40
+ ## What's Inside
24
41
 
25
- - **The Chapel** — a ruined chapel with interconnected rooms and hidden passages
26
- - **NPCs** — guards, ghouls, and spirits with distinct AI cognition profiles
27
- - **Items** — weapons, armor, potions, and quest items
28
- - **Dialogue** — branching conversations with condition-gated options
29
- - **Combat encounters** — enemies with varied tactics driven by the cognition system
42
+ - **5 zones** — Ruined Chapel Entrance, Nave, Shadowed Alcove, Vestry Passage, Crypt Antechamber
43
+ - **1 NPC** — Suspicious Pilgrim (branching dialogue, 3 conversation paths)
44
+ - **1 enemy** — Ash Ghoul (aggressive AI, fear of fire and sacred)
45
+ - **1 item** — Healing Draught (scripted use-effect restoring 8 HP)
46
+ - **1 progression tree** — Combat Mastery (Toughened Keen Eye Battle Fury)
47
+ - **1 presentation rule** — undead perceive all living as threats
48
+ - **15 modules wired** — traversal, status, combat, inventory, dialogue, cognition, perception, progression, environment, factions, rumors, districts, belief, observer presentation, inspector
30
49
 
31
50
  ## Usage
32
51
 
33
52
  ```typescript
34
- import { Engine } from '@ai-rpg-engine/core';
35
- import { combatCore, dialogueCore, cognitionCore } from '@ai-rpg-engine/modules';
36
- import { chapelThreshold } from '@ai-rpg-engine/starter-fantasy';
53
+ import { createGame } from '@ai-rpg-engine/starter-fantasy';
37
54
 
38
- const engine = new Engine({
39
- manifest: chapelThreshold.manifest,
40
- seed: 42,
41
- modules: [combatCore(), dialogueCore(), cognitionCore()],
42
- });
55
+ // One line all 15 modules, content, and ruleset pre-wired
56
+ const engine = createGame(42);
43
57
 
44
- engine.loadContentPack(chapelThreshold);
58
+ // Or import pieces individually:
59
+ import { manifest, zones, pilgrimDialogue, fantasyMinimalRuleset } from '@ai-rpg-engine/starter-fantasy';
45
60
  ```
46
61
 
47
62
  ## Documentation
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ai-rpg-engine/starter-fantasy",
3
- "version": "1.0.1",
3
+ "version": "2.0.0",
4
4
  "description": "AI RPG Engine fantasy starter: The Chapel Threshold",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -29,6 +29,10 @@
29
29
  "url": "https://github.com/mcp-tool-shop-org/ai-rpg-engine.git",
30
30
  "directory": "packages/starter-fantasy"
31
31
  },
32
+ "keywords": ["rpg", "fantasy", "game-engine", "starter", "worldbuilding", "content-pack"],
33
+ "bugs": {
34
+ "url": "https://github.com/mcp-tool-shop-org/ai-rpg-engine/issues"
35
+ },
32
36
  "engines": {
33
37
  "node": ">=20"
34
38
  }