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
400 lines
17 KiB
HTML
400 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Character Relationships - 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="character-relationships"><a class="header" href="#character-relationships">Character Relationships</a></h1>
|
||
<p>Characters exist in a web of connections – friendships, rivalries, parent-child bonds, and complex power dynamics. In Storybook, relationships are first-class declarations that capture these connections with nuance and perspective.</p>
|
||
<h2 id="basic-relationships"><a class="header" href="#basic-relationships">Basic Relationships</a></h2>
|
||
<p>The simplest relationship connects two characters with shared fields:</p>
|
||
<pre><code class="language-storybook">relationship MarthaAndEmma {
|
||
Martha as parent {}
|
||
Emma as child {}
|
||
|
||
bond: 0.95
|
||
type: "parent_child"
|
||
}
|
||
</code></pre>
|
||
<p>This says Martha and Emma share a relationship with a bond strength of 0.95 (very close). The <code>bond</code> field is shared – it applies equally to both participants.</p>
|
||
<h2 id="adding-roles"><a class="header" href="#adding-roles">Adding Roles</a></h2>
|
||
<p>Roles label each participant’s function in the relationship:</p>
|
||
<pre><code class="language-storybook">relationship ParentChild {
|
||
Martha as parent
|
||
Emma as child
|
||
|
||
bond: 0.95
|
||
guardianship: true
|
||
}
|
||
</code></pre>
|
||
<p>The <code>as parent</code> and <code>as child</code> labels clarify who plays which role. Roles are descriptive – you can use any name that makes sense.</p>
|
||
<h2 id="perspectives-self-and-other"><a class="header" href="#perspectives-self-and-other">Perspectives: Self and Other</a></h2>
|
||
<p>Real relationships are not symmetric. How one person sees the relationship may differ from how the other sees it. Storybook handles this with <code>self</code> and <code>other</code> blocks:</p>
|
||
<pre><code class="language-storybook">relationship MentorApprentice {
|
||
Martha as mentor self {
|
||
patience: 0.8
|
||
investment_in_student: 0.9
|
||
} other {
|
||
sees_potential: 0.85
|
||
frustration_level: 0.2
|
||
}
|
||
|
||
Elena as apprentice self {
|
||
dedication: 0.9
|
||
overwhelmed: 0.4
|
||
} other {
|
||
admiration: 0.95
|
||
desire_to_impress: 0.9
|
||
}
|
||
|
||
bond: 0.85
|
||
}
|
||
</code></pre>
|
||
<p>Reading this:</p>
|
||
<ul>
|
||
<li><strong>Martha’s self view</strong>: She feels patient (80%), highly invested in her student</li>
|
||
<li><strong>Martha’s view of Elena (other)</strong>: Sees high potential (85%) with low frustration (20%)</li>
|
||
<li><strong>Elena’s self view</strong>: Dedicated (90%) but sometimes overwhelmed (40%)</li>
|
||
<li><strong>Elena’s view of Martha (other)</strong>: Deep admiration (95%), strong desire to impress (90%)</li>
|
||
<li><strong>Shared</strong>: Their bond strength is 0.85</li>
|
||
</ul>
|
||
<h2 id="prose-in-relationships"><a class="header" href="#prose-in-relationships">Prose in Relationships</a></h2>
|
||
<p>Relationships can include narrative descriptions for each participant:</p>
|
||
<pre><code class="language-storybook">relationship MarthaAndGregory {
|
||
Martha {
|
||
role: shopkeeper
|
||
values_loyalty: 0.9
|
||
|
||
---perspective
|
||
Martha appreciates Gregory's unwavering loyalty. He has
|
||
been buying her sourdough loaf every morning for fifteen
|
||
years. Their brief daily exchanges about the weather and
|
||
local gossip are a comforting routine.
|
||
---
|
||
}
|
||
|
||
Gregory {
|
||
role: regular_customer
|
||
always_orders: "sourdough_loaf"
|
||
|
||
---perspective
|
||
Gregory considers Martha's bakery a cornerstone of his
|
||
daily routine. The bread is excellent, but it is the brief
|
||
human connection that keeps him coming back. He worries
|
||
about what would happen if she ever retired.
|
||
---
|
||
}
|
||
|
||
bond: 0.7
|
||
}
|
||
</code></pre>
|
||
<h2 id="multi-party-relationships"><a class="header" href="#multi-party-relationships">Multi-Party Relationships</a></h2>
|
||
<p>Relationships can involve more than two participants:</p>
|
||
<pre><code class="language-storybook">relationship BakerFamily {
|
||
Martha as parent
|
||
Jane as parent
|
||
Emma as child
|
||
|
||
household: "Baker Residence"
|
||
family_bond: 0.95
|
||
dinner_time: 18:00
|
||
|
||
---dynamics
|
||
A loving family running a bakery together. Martha handles
|
||
the bread, Jane manages pastries, and Emma helps out on
|
||
weekends while learning the craft.
|
||
---
|
||
}
|
||
</code></pre>
|
||
<h2 id="asymmetric-awareness"><a class="header" href="#asymmetric-awareness">Asymmetric Awareness</a></h2>
|
||
<p>Relationships can model situations where one party does not know the relationship exists:</p>
|
||
<pre><code class="language-storybook">relationship BossAndNewHire {
|
||
Martha {
|
||
role: boss
|
||
aware_of_struggles: false
|
||
expects: high_quality_work
|
||
|
||
---perspective
|
||
Martha sees the new hire as competent and expects them
|
||
to learn the bakery routines quickly. She has no idea
|
||
they are struggling with the early morning schedule.
|
||
---
|
||
}
|
||
|
||
NewHire {
|
||
role: employee
|
||
intimidated: 0.8
|
||
hides_struggles: true
|
||
|
||
---perspective
|
||
The new hire is in awe of Martha's skill but terrified
|
||
of disappointing her. They arrive thirty minutes early
|
||
every day to practice techniques before she gets in.
|
||
---
|
||
}
|
||
|
||
bond: 0.4
|
||
}
|
||
</code></pre>
|
||
<h2 id="institutional-relationships"><a class="header" href="#institutional-relationships">Institutional Relationships</a></h2>
|
||
<p>Institutions can participate in relationships too:</p>
|
||
<pre><code class="language-storybook">relationship GuildMembership {
|
||
Martha as member
|
||
BakersGuild as organization
|
||
|
||
membership_since: "2015-01-01"
|
||
standing: "good"
|
||
dues_paid: true
|
||
}
|
||
</code></pre>
|
||
<h2 id="building-a-relationship-web"><a class="header" href="#building-a-relationship-web">Building a Relationship Web</a></h2>
|
||
<p>Multiple relationships create a rich social network:</p>
|
||
<pre><code class="language-storybook">relationship Marriage {
|
||
Martha as spouse
|
||
Jane as spouse
|
||
bond: 0.9
|
||
}
|
||
|
||
relationship MentorApprentice {
|
||
Martha as mentor
|
||
Elena as apprentice
|
||
bond: 0.85
|
||
}
|
||
|
||
relationship RegularCustomer {
|
||
Martha as shopkeeper
|
||
Gregory as customer
|
||
bond: 0.7
|
||
}
|
||
|
||
relationship Colleagues {
|
||
Martha as peer
|
||
NeighborBaker as peer
|
||
bond: 0.5
|
||
competitive: true
|
||
}
|
||
</code></pre>
|
||
<h2 id="next-steps"><a class="header" href="#next-steps">Next Steps</a></h2>
|
||
<p>Characters have traits, behaviors, and relationships. In <a href="./07-schedules.html">Schedules and Time</a>, you will give them daily routines and time-based activities.</p>
|
||
<hr />
|
||
<p><strong>Reference</strong>: For complete relationship syntax, see the <a href="../reference/15-relationships.html">Relationships Reference</a>.</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="../tutorial/05-advanced-behaviors.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="../tutorial/07-schedules.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="../tutorial/05-advanced-behaviors.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="../tutorial/07-schedules.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>
|