Sienna Meridian Satterwhite
16deb5d237
BREAKING CHANGES: - Relationship syntax now requires blocks for all participants - Removed self/other perspective blocks from relationships - Replaced 'guard' keyword with 'if' for behavior tree decorators Language Features: - Add tree-sitter grammar with improved if/condition disambiguation - Add comprehensive tutorial and reference documentation - Add SBIR v0.2.0 binary format specification - Add resource linking system for behaviors and schedules - Add year-long schedule patterns (day, season, recurrence) - Add behavior tree enhancements (named nodes, decorators) Documentation: - Complete tutorial series (9 chapters) with baker family examples - Complete reference documentation for all language features - SBIR v0.2.0 specification with binary format details - Added locations and institutions documentation Examples: - Convert all examples to baker family scenario - Add comprehensive working examples Tooling: - Zed extension with LSP integration - Tree-sitter grammar for syntax highlighting - Build scripts and development tools Version Updates: - Main package: 0.1.0 → 0.2.0 - Tree-sitter grammar: 0.1.0 → 0.2.0 - Zed extension: 0.1.0 → 0.2.0 - Storybook editor: 0.1.0 → 0.2.0
538 lines
19 KiB
HTML
538 lines
19 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Day in the Life - Storybook Language Guide</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="Comprehensive documentation for the Storybook narrative simulation language">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff">
|
||
|
||
<link rel="icon" href="../favicon.svg">
|
||
<link rel="shortcut icon" href="../favicon.png">
|
||
<link rel="stylesheet" href="../css/variables.css">
|
||
<link rel="stylesheet" href="../css/general.css">
|
||
<link rel="stylesheet" href="../css/chrome.css">
|
||
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" href="../highlight.css">
|
||
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
|
||
|
||
<!-- Provide site root to javascript -->
|
||
<script>
|
||
var path_to_root = "../";
|
||
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="../toc.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
var theme = localStorage.getItem('mdbook-theme');
|
||
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
}
|
||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
}
|
||
} catch (e) { }
|
||
</script>
|
||
|
||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
<script>
|
||
var theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
var sidebar = null;
|
||
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
}
|
||
sidebar_toggle.checked = sidebar === 'visible';
|
||
html.classList.remove('sidebar-visible');
|
||
html.classList.add("sidebar-" + sidebar);
|
||
</script>
|
||
|
||
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
</noscript>
|
||
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="menu-bar-hover-placeholder"></div>
|
||
<div id="menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
<i class="fa fa-bars"></i>
|
||
</label>
|
||
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
<i class="fa fa-paint-brush"></i>
|
||
</button>
|
||
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
<i class="fa fa-search"></i>
|
||
</button>
|
||
</div>
|
||
|
||
<h1 class="menu-title">Storybook Language Guide</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
<i id="print-button" class="fa fa-print"></i>
|
||
</a>
|
||
<a href="https://github.com/r3t-studios/storybook" title="Git repository" aria-label="Git repository">
|
||
<i id="git-repository-button" class="fa fa-github"></i>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="search-wrapper" class="hidden">
|
||
<form id="searchbar-outer" class="searchbar-outer">
|
||
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
</form>
|
||
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="searchresults-header" class="searchresults-header"></div>
|
||
<ul id="searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="content" class="content">
|
||
<main>
|
||
<h1 id="day-in-the-life"><a class="header" href="#day-in-the-life">Day in the Life</a></h1>
|
||
<p>This example models a complete day for a baker character, showing how schedules, behaviors, and life arcs work together to create a rich daily simulation.</p>
|
||
<h2 id="the-baker"><a class="header" href="#the-baker">The Baker</a></h2>
|
||
<pre><code class="language-storybook">use schema::core_enums::{Season, DayOfWeek};
|
||
use schema::beings::Human;
|
||
use schema::templates::SkilledWorker;
|
||
|
||
character Martha: Human from SkilledWorker {
|
||
age: 42
|
||
occupation: "Master Baker"
|
||
skill_level: 0.95
|
||
energy: 1.0
|
||
mood: 0.8
|
||
|
||
uses schedule: MarthaDailySchedule
|
||
uses behaviors: [
|
||
{ tree: BakerRoutine, priority: normal },
|
||
{ tree: HandleEmergency, when: emergency_detected, priority: critical }
|
||
]
|
||
|
||
---backstory
|
||
Martha has been baking since she was twelve, learning from her
|
||
grandmother. She now runs the most popular bakery in town and
|
||
is known for her sourdough bread and apple pastries.
|
||
---
|
||
}
|
||
</code></pre>
|
||
<h2 id="the-schedule"><a class="header" href="#the-schedule">The Schedule</a></h2>
|
||
<pre><code class="language-storybook">schedule MarthaDailySchedule {
|
||
block wake_up {
|
||
04:00 - 04:30
|
||
action: routines::morning_wake
|
||
}
|
||
|
||
block early_baking {
|
||
04:30 - 07:00
|
||
action: baking::prepare_morning_goods
|
||
}
|
||
|
||
block open_shop {
|
||
07:00 - 07:15
|
||
action: shop::open_for_business
|
||
}
|
||
|
||
block morning_rush {
|
||
07:15 - 10:00
|
||
action: shop::serve_morning_customers
|
||
}
|
||
|
||
block midday_baking {
|
||
10:00 - 12:00
|
||
action: baking::prepare_afternoon_goods
|
||
}
|
||
|
||
block lunch_break {
|
||
12:00 - 13:00
|
||
action: social::lunch_with_family
|
||
}
|
||
|
||
block afternoon_sales {
|
||
13:00 - 16:00
|
||
action: shop::serve_afternoon_customers
|
||
}
|
||
|
||
block close_shop {
|
||
16:00 - 16:30
|
||
action: shop::close_for_day
|
||
}
|
||
|
||
block evening_prep {
|
||
16:30 - 17:30
|
||
action: baking::prepare_dough_for_tomorrow
|
||
}
|
||
|
||
block family_time {
|
||
18:00 - 21:00
|
||
action: social::family_evening
|
||
}
|
||
|
||
block sleep {
|
||
21:00 - 04:00
|
||
action: routines::sleep
|
||
}
|
||
|
||
// Saturday: Market day
|
||
recurs MarketDay on day saturday {
|
||
block market_prep {
|
||
03:00 - 05:00
|
||
action: baking::market_batch
|
||
}
|
||
|
||
block market_sales {
|
||
06:00 - 14:00
|
||
action: market::sell_at_stall
|
||
}
|
||
|
||
block market_cleanup {
|
||
14:00 - 15:00
|
||
action: market::pack_up
|
||
}
|
||
}
|
||
|
||
// Summer: Extended hours
|
||
block summer_afternoon {
|
||
13:00 - 18:00
|
||
action: shop::extended_summer_hours
|
||
on season summer
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h2 id="behaviors"><a class="header" href="#behaviors">Behaviors</a></h2>
|
||
<h3 id="morning-routine"><a class="header" href="#morning-routine">Morning Routine</a></h3>
|
||
<pre><code class="language-storybook">behavior BakerMorningRoutine {
|
||
then morning_sequence {
|
||
WakeUp
|
||
WashFace
|
||
DressInWorkClothes
|
||
|
||
// Check the sourdough starter
|
||
then check_starter {
|
||
ExamineStarter
|
||
if(starter_healthy) {
|
||
FeedStarter
|
||
}
|
||
}
|
||
|
||
WalkToKitchen
|
||
LightOven
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3 id="baking-behavior"><a class="header" href="#baking-behavior">Baking Behavior</a></h3>
|
||
<pre><code class="language-storybook">behavior BakerRoutine {
|
||
choose baking_priority {
|
||
// Handle special orders first
|
||
then special_orders {
|
||
if(has_special_orders)
|
||
then fill_order {
|
||
ReviewOrderDetails
|
||
GatherSpecialIngredients
|
||
PrepareSpecialItem
|
||
PackageForCustomer
|
||
}
|
||
}
|
||
|
||
// Regular daily baking
|
||
then daily_bread {
|
||
then sourdough {
|
||
MixDough(recipe: "sourdough", quantity: 10)
|
||
KneadDough(duration: 15m)
|
||
FirstRise(duration: 2h)
|
||
ShapLoaves
|
||
SecondRise(duration: 1h)
|
||
BakeLoaves(temperature: 230, duration: 35m)
|
||
}
|
||
}
|
||
|
||
// Pastries if time permits
|
||
then pastries {
|
||
succeed_always {
|
||
then apple_pastries {
|
||
PrepareFillingApple
|
||
RollPastryDough
|
||
AssemblePastries
|
||
BakePastries(temperature: 200, duration: 25m)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3 id="customer-service"><a class="header" href="#customer-service">Customer Service</a></h3>
|
||
<pre><code class="language-storybook">behavior ServeCustomer {
|
||
then service_sequence {
|
||
GreetCustomer
|
||
if(customer_is_regular) {
|
||
RecallPreferences
|
||
}
|
||
|
||
choose service_type {
|
||
then take_order {
|
||
if(customer_knows_what_they_want)
|
||
AcceptOrder
|
||
PackageItem
|
||
}
|
||
|
||
then help_decide {
|
||
if(not customer_knows_what_they_want)
|
||
OfferRecommendation
|
||
ProvidesSample
|
||
AcceptOrder
|
||
PackageItem
|
||
}
|
||
}
|
||
|
||
CollectPayment
|
||
ThankCustomer
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h3 id="emergency-handling"><a class="header" href="#emergency-handling">Emergency Handling</a></h3>
|
||
<pre><code class="language-storybook">behavior HandleEmergency {
|
||
choose emergency_type {
|
||
then oven_fire {
|
||
if(oven_overheating)
|
||
TurnOffOven
|
||
GrabFireExtinguisher
|
||
ExtinguishFire
|
||
AssessDamage
|
||
}
|
||
|
||
then ingredient_shortage {
|
||
if(critical_ingredient_missing)
|
||
CheckBackupSupply
|
||
choose procurement {
|
||
SendApprenticeToMarket
|
||
SubstituteIngredient
|
||
AdjustMenu
|
||
}
|
||
}
|
||
|
||
then equipment_failure {
|
||
if(equipment_broken)
|
||
StopProduction
|
||
AttemptQuickFix
|
||
choose fallback {
|
||
UseBackupEquipment
|
||
CallRepairPerson
|
||
}
|
||
}
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h2 id="life-arc-career-and-energy"><a class="header" href="#life-arc-career-and-energy">Life Arc: Career and Energy</a></h2>
|
||
<pre><code class="language-storybook">life_arc MarthaEnergyLevel {
|
||
state rested {
|
||
on enter {
|
||
Martha.energy: 1.0
|
||
Martha.mood: 0.8
|
||
}
|
||
on energy < 0.5 -> tired
|
||
}
|
||
|
||
state tired {
|
||
on enter {
|
||
Martha.mood: 0.6
|
||
}
|
||
on energy < 0.2 -> exhausted
|
||
on energy > 0.7 -> rested
|
||
}
|
||
|
||
state exhausted {
|
||
on enter {
|
||
Martha.mood: 0.3
|
||
Martha.quality_output: 0.7
|
||
}
|
||
on energy > 0.5 -> tired
|
||
}
|
||
}
|
||
</code></pre>
|
||
<h2 id="relationships"><a class="header" href="#relationships">Relationships</a></h2>
|
||
<pre><code class="language-storybook">relationship MarthaAndApprentice {
|
||
Martha as mentor self {
|
||
patience: 0.8
|
||
investment: 0.9
|
||
} other {
|
||
sees_potential: 0.85
|
||
}
|
||
|
||
Elena as apprentice self {
|
||
dedication: 0.9
|
||
learning_rate: 0.7
|
||
} other {
|
||
respect: 0.95
|
||
admiration: 0.8
|
||
}
|
||
|
||
bond: 0.85
|
||
years_together: 2
|
||
}
|
||
|
||
relationship MarthaAndRegularCustomer {
|
||
Martha as shopkeeper
|
||
OldManGregory as regular_customer
|
||
|
||
bond: 0.7
|
||
years_known: 15
|
||
always_orders: "sourdough_loaf"
|
||
|
||
---dynamics
|
||
Gregory has been buying Martha's bread every morning for
|
||
fifteen years. They exchange brief pleasantries about the
|
||
weather and local gossip. He is her most reliable customer.
|
||
---
|
||
}
|
||
</code></pre>
|
||
<h2 id="key-takeaways"><a class="header" href="#key-takeaways">Key Takeaways</a></h2>
|
||
<p>This example demonstrates:</p>
|
||
<ol>
|
||
<li><strong>Schedule-driven daily flow</strong>: Precise time blocks govern Martha’s entire day</li>
|
||
<li><strong>Seasonal and weekly variations</strong>: Summer hours and Saturday market</li>
|
||
<li><strong>Layered behaviors</strong>: Emergency behavior preempts normal routine via priority</li>
|
||
<li><strong>Realistic action sequences</strong>: Baking modeled step by step with parameters</li>
|
||
<li><strong>Energy management</strong>: Life arc tracks fatigue affecting mood and output quality</li>
|
||
<li><strong>Social connections</strong>: Relationships with apprentice and customers add depth</li>
|
||
</ol>
|
||
<h2 id="cross-references"><a class="header" href="#cross-references">Cross-References</a></h2>
|
||
<ul>
|
||
<li><a href="../reference/14-schedules.html">Schedules Reference</a> - Schedule syntax</li>
|
||
<li><a href="../reference/11-behavior-trees.html">Behavior Trees Reference</a> - Behavior syntax</li>
|
||
<li><a href="../reference/13-life-arcs.html">Life Arcs Reference</a> - Life arc syntax</li>
|
||
</ul>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="../examples/24-baker-family-complete.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="../examples/26-character-evolution.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="../examples/24-baker-family-complete.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="../examples/26-character-evolution.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<!-- Livereload script (if served using the cli tool) -->
|
||
<script>
|
||
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
|
||
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
|
||
const socket = new WebSocket(wsAddress);
|
||
socket.onmessage = function (event) {
|
||
if (event.data === "reload") {
|
||
socket.close();
|
||
location.reload();
|
||
}
|
||
};
|
||
|
||
window.onbeforeunload = function() {
|
||
socket.close();
|
||
}
|
||
</script>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="../elasticlunr.min.js"></script>
|
||
<script src="../mark.min.js"></script>
|
||
<script src="../searcher.js"></script>
|
||
|
||
<script src="../clipboard.min.js"></script>
|
||
<script src="../highlight.js"></script>
|
||
<script src="../book.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|