8 Commits

Author SHA1 Message Date
max 4de15b19c8 feat: wire up planty with nodarium/app
📊 Benchmark the Runtime / release (push) Successful in 3m55s
🚀 Lint & Test & Deploy / release (push) Failing after 56s
2026-04-20 01:08:52 +02:00
max 168e6fcc19 feat: update some node default settings 2026-04-20 01:08:41 +02:00
max c0eb75d53c feat: new planty package 2026-04-20 01:08:29 +02:00
max 2ec9bfc3c9 feat(ci): compress benchmark data
📊 Benchmark the Runtime / release (push) Successful in 1m20s
🚀 Lint & Test & Deploy / release (push) Successful in 4m7s
2026-02-13 15:21:57 +01:00
max c97520617a fix(ci): use older upload-artifact action
📊 Benchmark the Runtime / release (push) Successful in 1m16s
🚀 Lint & Test & Deploy / release (push) Successful in 4m23s
2026-02-13 15:01:59 +01:00
max 6475790176 fix(ci): build nodes before benchmarking
📊 Benchmark the Runtime / release (push) Failing after 1m16s
🚀 Lint & Test & Deploy / release (push) Has been cancelled
2026-02-13 14:57:07 +01:00
max 580ec73465 ci: run benchmark in ci
📊 Benchmark the Runtime / release (push) Failing after 42s
🚀 Lint & Test & Deploy / release (push) Successful in 4m20s
2026-02-13 14:46:21 +01:00
nodarium-bot fd98d457a3 chore(release): v0.0.5 2026-02-13 01:47:35 +00:00
51 changed files with 3905 additions and 458 deletions
+59
View File
@@ -0,0 +1,59 @@
name: 📊 Benchmark the Runtime
on:
push:
branches: ["*"]
pull_request:
branches: ["*"]
env:
PNPM_CACHE_FOLDER: .pnpm-store
CARGO_HOME: .cargo
CARGO_TARGET_DIR: target
jobs:
release:
runs-on: ubuntu-latest
container: git.max-richter.dev/max/nodarium-ci:bce06da456e3c008851ac006033cfff256015a47
steps:
- name: 📑 Checkout Code
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITEA_TOKEN }}
- name: 💾 Setup pnpm Cache
uses: actions/cache@v4
with:
path: ${{ env.PNPM_CACHE_FOLDER }}
key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-
- name: 🦀 Cache Cargo
uses: actions/cache@v4
with:
path: |
~/.cargo/registry
~/.cargo/git
target
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-
- name: 📦 Install Dependencies
run: pnpm install --frozen-lockfile --store-dir ${{ env.PNPM_CACHE_FOLDER }}
- name: 🛠️Build Nodes
run: pnpm build:nodes
- name: 🏃 Execute Runtime
run: pnpm run --filter @nodarium/app bench
- name: 📤 Upload Benchmark Results
uses: actions/upload-artifact@v3
with:
name: benchmark-data
path: app/benchmark/out/
compression: 9
+65
View File
@@ -1,3 +1,68 @@
# v0.0.5 (2026-02-13)
## Features
- Implement debug node with full runtime integration, wildcard (`*`) inputs, variable-height nodes and parameters, and a quick-connect shortcut.
- Add color-coded node sockets and edges to visually indicate data types.
- Recursively merge `localState` with the initial state to safely handle outdated settings stored in `localStorage` when the settings schema changes.
- Clamp the Add Menu to the viewport.
- Add application favicon.
- Consolidate all developer settings into a single **Advanced Mode** setting.
## Fixes
- Fix InputNumber arrow visibility in the light theme.
- Correct changelog formatting issues.
## Chores
- Add `pnpm qa` pre-commit command.
- Run linting and type checks before build in CI.
- Sign release commits with a PGP key.
- General formatting, lint/type cleanup, test snapshot updates, and `.gitignore` maintenance.
---
- [f16ba26](https://git.max-richter.dev/max/nodarium/commit/f16ba2601ff0e8f0f4454e24689499112a2a257a) fix(ci): still trying to get gpg to work
- [cc6b832](https://git.max-richter.dev/max/nodarium/commit/cc6b832f1576356e5453ee4289b02f854152ff9a) fix(ci): trying to get gpg to work
- [dd5fd5b](https://git.max-richter.dev/max/nodarium/commit/dd5fd5bf1715d371566bd40419b72ca05e63401e) fix(ci): better add updates to package.json
- [38d0fff](https://git.max-richter.dev/max/nodarium/commit/38d0fffcf4ca0a346857c3658ccefdfcdf16e217) chore: update ci image
- [bce06da](https://git.max-richter.dev/max/nodarium/commit/bce06da456e3c008851ac006033cfff256015a47) ci: add gpg-agent to ci image
- [af585d5](https://git.max-richter.dev/max/nodarium/commit/af585d56ec825662961c8796226ed9d8cb900795) feat: use new ci image with gpg
- [0aa73a2](https://git.max-richter.dev/max/nodarium/commit/0aa73a27c1f23bea177ecc66034f8e0384c29a8e) feat: install gpg in ci image
- [c1ae702](https://git.max-richter.dev/max/nodarium/commit/c1ae70282cb5d58527180614a80823d80ca478c5) feat: add color to sockets
- [4c7b03d](https://git.max-richter.dev/max/nodarium/commit/4c7b03dfb82174317d8ba01f4725af804201154d) feat: add gradient mesh line
- [144e8cc](https://git.max-richter.dev/max/nodarium/commit/144e8cc797cfcc5a7a1fd9a0a2098dc99afb6170) fix: correctly highlight possible outputs
- [12ff9c1](https://git.max-richter.dev/max/nodarium/commit/12ff9c151873d253ed2e54dcf56aa9c9c4716c7c) Merge pull request 'feat/debug-node' (#41) from feat/debug-node into main
- [8d3ffe8](https://git.max-richter.dev/max/nodarium/commit/8d3ffe84ab9ca9e6d6d28333752e34da878fd3ea) Merge branch 'main' into feat/debug-node
- [95ec93e](https://git.max-richter.dev/max/nodarium/commit/95ec93eeada9bf062e01e1e77b67b8f0343a51bf) feat: better handle ctrl+shift clicks and selections
- [d39185e](https://git.max-richter.dev/max/nodarium/commit/d39185efafc360f49ab9437c0bad1f64665df167) feat: add "pnpm qa" command to check before commit
- [81580cc](https://git.max-richter.dev/max/nodarium/commit/81580ccd8c1db30ce83433c4c4df84bd660d3460) fix: cleanup some type errors
- [bf6f632](https://git.max-richter.dev/max/nodarium/commit/bf6f632d2772c3da812d5864c401f17e1aa8666a) feat: add shortcut to quick connect to debug
- [e098be6](https://git.max-richter.dev/max/nodarium/commit/e098be60135f57cf863904a58489e032ed27e8b4) fix: also execute all nodes before debug node
- [ec13850](https://git.max-richter.dev/max/nodarium/commit/ec13850e1c0ca5846da614d25887ff492cf8be04) fix: make debug node work with runtime
- [15e08a8](https://git.max-richter.dev/max/nodarium/commit/15e08a816339bdf9de9ecb6a57a7defff42dbe8c) feat: implement debug node
- [48cee58](https://git.max-richter.dev/max/nodarium/commit/48cee58ad337c1c6c59a0eb55bf9b5ecd16b99d0) chore: update test snapshots
- [3235cae](https://git.max-richter.dev/max/nodarium/commit/3235cae9049e193c242b6091cee9f01e67ee850e) chore: fix lint and typecheck errors
- [3f44072](https://git.max-richter.dev/max/nodarium/commit/3f440728fc8a94d59022bb545f418be049a1f1ba) feat: implement variable height for node shader
- [da09f8b](https://git.max-richter.dev/max/nodarium/commit/da09f8ba1eda5ed347433d37064a3b4ab49e627e) refactor: move debug node into runtime
- [ddc3b4c](https://git.max-richter.dev/max/nodarium/commit/ddc3b4ce357ef1c1e8066c0a52151713d0b6ed95) feat: allow variable height node parameters
- [2690fc8](https://git.max-richter.dev/max/nodarium/commit/2690fc871291e73d3d028df9668e8fffb1e77476) chore: gitignore pnpm-store
- [072ab90](https://git.max-richter.dev/max/nodarium/commit/072ab9063ba56df0673020eb639548f3a8601e04) feat: add initial debug node
- [e23cad2](https://git.max-richter.dev/max/nodarium/commit/e23cad254d610e00f196b7fdb4532f36fd735a4b) feat: add "*" datatype for inputs for debug node
- [5b5c63c](https://git.max-richter.dev/max/nodarium/commit/5b5c63c1a9c4ef757382bd4452149dc9777693ff) fix(ui): make arrows on inputnumber visible on lighttheme
- [c9021f2](https://git.max-richter.dev/max/nodarium/commit/c9021f2383828f2e2b5594d125165bbc8f70b8e7) refactor: merge all dev settings into one setting
- [9eecdd4](https://git.max-richter.dev/max/nodarium/commit/9eecdd4fb85dc60b8196101050334e26732c9a34) Merge pull request 'feat: merge localState recursively with initial' (#38) from feat/debug-node into main
- [7e71a41](https://git.max-richter.dev/max/nodarium/commit/7e71a41e5229126d404f56598c624709961dbf3b) feat: merge localState recursively with initial
- [07cd9e8](https://git.max-richter.dev/max/nodarium/commit/07cd9e84eb51bc02b7fed39c36cf83caba175ad7) feat: clamp AddMenu to viewport
- [a31a49a](https://git.max-richter.dev/max/nodarium/commit/a31a49ad503d69f92f2491dd685729060ea49896) ci: lint and typecheck before build
- [850d641](https://git.max-richter.dev/max/nodarium/commit/850d641a25cd0c781478c58c117feaf085bdbc62) chore: pnpm format
- [ee5ca81](https://git.max-richter.dev/max/nodarium/commit/ee5ca817573b83cacfa3709e0ae88c6263bc39c1) ci: sign release commits with pgp key
- [22a1183](https://git.max-richter.dev/max/nodarium/commit/22a11832b861ae8b44e2d374b55d12937ecab247) fix(ci): correctly format changelog
- [b5ce572](https://git.max-richter.dev/max/nodarium/commit/b5ce5723fa4a35443df39a9096d0997f808f0b4f) chore: format favicon svg
- [102130c](https://git.max-richter.dev/max/nodarium/commit/102130cc7777ceebcdb3de8466c90cef5b380111) feat: add favicon
- [1668a2e](https://git.max-richter.dev/max/nodarium/commit/1668a2e6d59db071ab3da45204c2b7bfcd2150a2) chore: format changelog.md
# v0.0.4 (2026-02-10)
## Features
+1
View File
@@ -0,0 +1 @@
out/
+47
View File
@@ -0,0 +1,47 @@
import { NodeDefinition, NodeId, NodeRegistry } from '@nodarium/types';
import { createWasmWrapper } from '@nodarium/utils';
import { readFile } from 'node:fs/promises';
import { resolve } from 'node:path';
export class BenchmarkRegistry implements NodeRegistry {
status: 'loading' | 'ready' | 'error' = 'loading';
private nodes = new Map<string, NodeDefinition>();
async load(nodeIds: NodeId[]): Promise<NodeDefinition[]> {
const nodes = await Promise.all(nodeIds.map(async id => {
const p = resolve('static/nodes/' + id + '.wasm');
const file = await readFile(p);
const node = createWasmWrapper(file as unknown as ArrayBuffer);
const d = node.get_definition();
return {
...d,
execute: node.execute
};
}));
for (const n of nodes) {
this.nodes.set(n.id, n);
}
this.status = 'ready';
return nodes;
}
async register(id: string, wasmBuffer: ArrayBuffer): Promise<NodeDefinition> {
const wasm = createWasmWrapper(wasmBuffer);
const d = wasm.get_definition();
const node = {
...d,
execute: wasm.execute
};
this.nodes.set(id, node);
return node;
}
getNode(id: NodeId | string): NodeDefinition | undefined {
return this.nodes.get(id);
}
getAllNodes(): NodeDefinition[] {
return [];
}
}
+56
View File
@@ -0,0 +1,56 @@
import type { Graph, Graph as GraphType, NodeId } from '@nodarium/types';
import { createLogger, createPerformanceStore } from '@nodarium/utils';
import { mkdir, writeFile } from 'node:fs/promises';
import { resolve } from 'node:path';
import { MemoryRuntimeExecutor } from '../src/lib/runtime/runtime-executor.ts';
import { BenchmarkRegistry } from './benchmarkRegistry.ts';
import defaultPlantTemplate from './templates/default.json' assert { type: 'json' };
import lottaFacesTemplate from './templates/lotta-faces.json' assert { type: 'json' };
import plantTemplate from './templates/plant.json' assert { type: 'json' };
const registry = new BenchmarkRegistry();
const r = new MemoryRuntimeExecutor(registry);
const perfStore = createPerformanceStore();
const log = createLogger('bench');
const templates: Record<string, Graph> = {
'plant': plantTemplate as unknown as GraphType,
'lotta-faces': lottaFacesTemplate as unknown as GraphType,
'default': defaultPlantTemplate as unknown as GraphType
};
async function run(g: GraphType, amount: number) {
await registry.load(plantTemplate.nodes.map(n => n.type) as NodeId[]);
log.log('loaded ' + g.nodes.length + ' nodes');
log.log('warming up');
// Warm up the runtime? maybe this does something?
for (let index = 0; index < 10; index++) {
await r.execute(g, { randomSeed: true });
}
log.log('executing');
r.perf = perfStore;
for (let i = 0; i < amount; i++) {
r.perf?.startRun();
await r.execute(g, { randomSeed: true });
r.perf?.stopRun();
}
log.log('finished');
return r.perf.get();
}
async function main() {
const outPath = resolve('benchmark/out/');
await mkdir(outPath, { recursive: true });
for (const key in templates) {
log.log('executing ' + key);
const perfData = await run(templates[key], 100);
await writeFile(resolve(outPath, key + '.json'), JSON.stringify(perfData));
await new Promise(res => setTimeout(res, 200));
}
}
main();
+95
View File
@@ -0,0 +1,95 @@
{
"settings": { "resolution.circle": 26, "resolution.curve": 39 },
"nodes": [
{ "id": 9, "position": [220, 80], "type": "max/plantarium/output", "props": {} },
{
"id": 10,
"position": [95, 80],
"type": "max/plantarium/stem",
"props": { "amount": 5, "length": 11, "thickness": 0.1 }
},
{
"id": 14,
"position": [195, 80],
"type": "max/plantarium/gravity",
"props": {
"strength": 0.38,
"scale": 39,
"fixBottom": 0,
"directionalStrength": [1, 1, 1],
"depth": 1,
"curviness": 1
}
},
{
"id": 15,
"position": [120, 80],
"type": "max/plantarium/noise",
"props": {
"strength": 4.9,
"scale": 2.2,
"fixBottom": 1,
"directionalStrength": [1, 1, 1],
"depth": 1,
"octaves": 1
}
},
{
"id": 16,
"position": [70, 80],
"type": "max/plantarium/vec3",
"props": { "0": 0, "1": 0, "2": 0 }
},
{
"id": 17,
"position": [45, 80],
"type": "max/plantarium/random",
"props": { "min": -2, "max": 2 }
},
{
"id": 18,
"position": [170, 80],
"type": "max/plantarium/branch",
"props": {
"length": 1.6,
"thickness": 0.69,
"amount": 36,
"offsetSingle": 0.5,
"lowestBranch": 0.46,
"highestBranch": 1,
"depth": 1,
"rotation": 180
}
},
{
"id": 19,
"position": [145, 80],
"type": "max/plantarium/gravity",
"props": {
"strength": 0.38,
"scale": 39,
"fixBottom": 0,
"directionalStrength": [1, 1, 1],
"depth": 1,
"curviness": 1
}
},
{
"id": 20,
"position": [70, 120],
"type": "max/plantarium/random",
"props": { "min": 0.073, "max": 0.15 }
}
],
"edges": [
[14, 0, 9, "input"],
[10, 0, 15, "plant"],
[16, 0, 10, "origin"],
[17, 0, 16, "0"],
[17, 0, 16, "2"],
[18, 0, 14, "plant"],
[15, 0, 19, "plant"],
[19, 0, 18, "plant"],
[20, 0, 10, "thickness"]
]
}
+44
View File
@@ -0,0 +1,44 @@
{
"settings": { "resolution.circle": 64, "resolution.curve": 64, "randomSeed": false },
"nodes": [
{ "id": 9, "position": [260, 0], "type": "max/plantarium/output", "props": {} },
{
"id": 18,
"position": [185, 0],
"type": "max/plantarium/stem",
"props": { "amount": 64, "length": 12, "thickness": 0.15 }
},
{
"id": 19,
"position": [210, 0],
"type": "max/plantarium/noise",
"props": { "scale": 1.3, "strength": 5.4 }
},
{
"id": 20,
"position": [235, 0],
"type": "max/plantarium/branch",
"props": { "length": 0.8, "thickness": 0.8, "amount": 3 }
},
{
"id": 21,
"position": [160, 0],
"type": "max/plantarium/vec3",
"props": { "0": 0.39, "1": 0, "2": 0.41 }
},
{
"id": 22,
"position": [130, 0],
"type": "max/plantarium/random",
"props": { "min": -2, "max": 2 }
}
],
"edges": [
[18, 0, 19, "plant"],
[19, 0, 20, "plant"],
[20, 0, 9, "input"],
[21, 0, 18, "origin"],
[22, 0, 21, "0"],
[22, 0, 21, "2"]
]
}
+71
View File
@@ -0,0 +1,71 @@
{
"settings": { "resolution.circle": 26, "resolution.curve": 39 },
"nodes": [
{ "id": 9, "position": [180, 80], "type": "max/plantarium/output", "props": {} },
{
"id": 10,
"position": [55, 80],
"type": "max/plantarium/stem",
"props": { "amount": 1, "length": 11, "thickness": 0.71 }
},
{
"id": 11,
"position": [80, 80],
"type": "max/plantarium/noise",
"props": {
"strength": 35,
"scale": 4.6,
"fixBottom": 1,
"directionalStrength": [1, 0.74, 0.083],
"depth": 1
}
},
{
"id": 12,
"position": [105, 80],
"type": "max/plantarium/branch",
"props": {
"length": 3,
"thickness": 0.6,
"amount": 10,
"rotation": 180,
"offsetSingle": 0.34,
"lowestBranch": 0.53,
"highestBranch": 1,
"depth": 1
}
},
{
"id": 13,
"position": [130, 80],
"type": "max/plantarium/noise",
"props": {
"strength": 8,
"scale": 7.7,
"fixBottom": 1,
"directionalStrength": [1, 0, 1],
"depth": 1
}
},
{
"id": 14,
"position": [155, 80],
"type": "max/plantarium/gravity",
"props": {
"strength": 0.11,
"scale": 39,
"fixBottom": 0,
"directionalStrength": [1, 1, 1],
"depth": 1,
"curviness": 1
}
}
],
"edges": [
[10, 0, 11, "plant"],
[11, 0, 12, "plant"],
[12, 0, 13, "plant"],
[13, 0, 14, "plant"],
[14, 0, 9, "input"]
]
}
+5 -2
View File
@@ -1,7 +1,7 @@
{
"name": "@nodarium/app",
"private": true,
"version": "0.0.4",
"version": "0.0.5",
"type": "module",
"scripts": {
"dev": "vite dev",
@@ -14,11 +14,13 @@
"format": "dprint fmt -c '../.dprint.jsonc' .",
"format:check": "dprint check -c '../.dprint.jsonc' .",
"lint": "eslint .",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json"
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"bench": "tsx ./benchmark/index.ts"
},
"dependencies": {
"@nodarium/ui": "workspace:*",
"@nodarium/utils": "workspace:*",
"@nodarium/planty": "workspace:*",
"@sveltejs/kit": "^2.50.2",
"@tailwindcss/vite": "^4.1.18",
"@threlte/core": "8.3.1",
@@ -51,6 +53,7 @@
"svelte": "^5.49.2",
"svelte-check": "^4.3.6",
"tslib": "^2.8.1",
"tsx": "^4.21.0",
"typescript": "^5.9.3",
"typescript-eslint": "^8.54.0",
"vite": "^7.3.1",
+2
View File
@@ -1,5 +1,7 @@
@import "tailwindcss";
@source "../../packages/ui/**/*.svelte";
@source "../../packages/planty/src/lib/**/*.svelte";
@plugin "@iconify/tailwind4" {
prefix: "i";
icon-sets: from-folder("custom", "./src/lib/icons");
+1
View File
@@ -6,3 +6,4 @@ export { default as lottaNodes } from './lotta-nodes.json';
export { plant } from './plant';
export { default as simple } from './simple.json';
export { tree } from './tree';
export { default as tutorial } from './tutorial.json';
+3 -3
View File
@@ -3,7 +3,7 @@
"settings": {
"resolution.circle": 54,
"resolution.curve": 20,
"randomSeed": true
"randomSeed": false
},
"meta": {
"title": "New Project",
@@ -27,9 +27,9 @@
],
"type": "max/plantarium/stem",
"props": {
"amount": 50,
"amount": 4,
"length": 4,
"thickness": 1
"thickness": 0.2
}
},
{
+24
View File
@@ -0,0 +1,24 @@
{
"id": 0,
"settings": {
"resolution.circle": 54,
"resolution.curve": 20,
"randomSeed": false
},
"meta": {
"title": "New Project",
"lastModified": "2026-02-03T16:56:40.375Z"
},
"nodes": [
{
"id": 9,
"position": [
215,
85
],
"type": "max/plantarium/output",
"props": {}
}
],
"edges": []
}
+8 -7
View File
@@ -28,13 +28,14 @@
key?: string;
value: SettingsValue;
type: SettingsType;
onButtonClick?: (id: string) => void;
depth?: number;
};
// Local persistent state for <details> sections
const openSections = localState<Record<string, boolean>>('open-details', {});
let { id, key = '', value = $bindable(), type, depth = 0 }: Props = $props();
let { id, key = '', value = $bindable(), type, onButtonClick, depth = 0 }: Props = $props();
function isNodeInput(v: SettingsNode | undefined): v is InputType {
return !!v && typeof v === 'object' && 'type' in v;
@@ -107,11 +108,6 @@
}
});
function handleClick() {
const callback = value[key] as unknown as () => void;
callback();
}
onMount(() => {
open = openSections.value[id];
@@ -130,7 +126,7 @@
{@const inputType = type[key]}
<div class="input input-{inputType.type}" class:first-level={depth === 1}>
{#if inputType.type === 'button'}
<button onclick={handleClick}>
<button onclick={() => onButtonClick?.(id)}>
{inputType.label || key}
</button>
{:else}
@@ -143,6 +139,7 @@
{:else if depth === 0}
{#each Object.keys(type ?? {}).filter((k) => k !== 'title') as childKey (childKey)}
<NestedSettings
{onButtonClick}
id={`${id}.${childKey}`}
key={childKey}
bind:value
@@ -160,6 +157,7 @@
<div class="content">
{#each Object.keys(type[key] as SettingsGroup).filter((k) => k !== 'title') as childKey (childKey)}
<NestedSettings
{onButtonClick}
id={`${id}.${childKey}`}
key={childKey}
bind:value={value[key] as SettingsValue}
@@ -221,6 +219,9 @@
button {
cursor: pointer;
background: var(--color-layer-2);
padding-block: 5px;
border-radius: 4px;
}
hr {
+6 -3
View File
@@ -28,6 +28,10 @@ export const AppSettingTypes = {
label: 'Center Camera',
value: true
},
clippy: {
type: 'button',
label: '🌱 Open Planty'
},
nodeInterface: {
title: 'Node Interface',
backgroundType: {
@@ -109,9 +113,8 @@ export const AppSettingTypes = {
}
} as const;
type SettingsToStore<T> = T extends { type: 'button' } ? () => void
: T extends { value: infer V } ? V extends readonly string[] ? V[number]
: V
type SettingsToStore<T> = T extends { value: infer V } ? V extends readonly string[] ? V[number]
: V
: T extends object ? {
-readonly [K in keyof T as T[K] extends object ? K : never]: SettingsToStore<T[K]>;
}
+264
View File
@@ -0,0 +1,264 @@
import type { PlantyConfig } from '@nodarium/planty';
export const tutorialConfig: PlantyConfig = {
id: 'nodarium-tutorial',
avatar: {
name: 'Planty',
defaultPosition: 'bottom-right'
},
start: 'intro',
nodes: {
// ── Entry ──────────────────────────────────────────────────────────────
intro: {
position: 'center',
text:
"# Hi, I'm Planty! 🌱\nI'll show you around Nodarium — a tool for building 3D plants by connecting nodes together.\nHow much detail do you want?",
choices: [
{ label: '🌱 Show me the basics', next: 'tour_canvas' },
{ label: '🤓 I want the technical details', next: 'tour_canvas_nerd' },
{ label: 'Skip the tour for now', next: null }
]
},
// ── Simple path ────────────────────────────────────────────────────────
tour_canvas: {
position: 'bottom-left',
hook: 'setup-default',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
'This is the **graph canvas**. Nodes connect together to build a plant — the 3D model updates automatically whenever you make a change.\nEach node does one specific job: grow stems, add noise, produce output.',
waitFor: 'click',
next: 'tour_viewer'
},
tour_viewer: {
position: 'top-left',
highlight: { selector: '.cell:first-child', padding: 8 },
text:
'This is the **3D viewer** — the live preview of your plant.\nLeft-click to rotate · right-click to pan · scroll to zoom.',
waitFor: 'click',
next: 'try_params'
},
try_params: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
'Click a node to select it. Its settings appear **directly on the node** — try changing a value and watch the plant update.\nThe sidebar shows extra hidden settings for the selected node.',
waitFor: 'click',
next: 'start_building'
},
start_building: {
position: 'center',
hook: 'load-tutorial-template',
text:
"Now let's build your own plant from scratch!\nI've loaded a blank project — it only has an **Output** node. Your goal: connect nodes to make a plant.",
waitFor: 'click',
next: 'add_stem_node'
},
add_stem_node: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
"Open the **Add Menu** with **Shift+A** or **right-click** on the canvas.\nAdd a **Stem** node, then connect its output socket to the Output node's input.",
waitFor: 'click',
next: 'add_noise_node'
},
add_noise_node: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
'Add a **Noise** node the same way.\nConnect: Stem → Noise input, then Noise output → Output.\nThis makes the stems grow in organic, curved shapes.',
waitFor: 'click',
next: 'add_random_node'
},
add_random_node: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
"Let's add some randomness! Add a **Random** node and connect its output to the **thickness** or **length** input of the Stem node.\nThe default min/max range is small — **Ctrl+drag** any number field to exceed its normal limits.",
waitFor: 'click',
next: 'prompt_regenerate'
},
prompt_regenerate: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
'Now press **R** to regenerate. Each press gives the Random node a new value — your plant changes every run!',
waitFor: 'click',
next: 'tour_sidebar'
},
tour_sidebar: {
position: 'right',
highlight: { selector: '.tabs', padding: 4 },
text:
'The **sidebar** holds all your tools:\n⚙️ Settings · ⌨️ Shortcuts · 📦 Export · 📁 Projects · 📊 Graph Settings\nEnable **Advanced Mode** in Settings to unlock performance and benchmark panels.',
waitFor: 'click',
next: 'save_project'
},
save_project: {
position: 'right',
highlight: { selector: '.tabs', padding: 4 },
text:
'Your work is saved in the **Projects panel** — rename it, create new projects, or switch between them anytime.',
waitFor: 'click',
next: 'congrats'
},
congrats: {
position: 'center',
text:
"# You're all set! 🎉\nYou know how to build plants, tweak parameters, and save your work.\nWant to explore more?",
choices: [
{ label: '🔗 How do node connections work?', next: 'connections_intro' },
{ label: '💡 Ideas for improving this plant', next: 'improvements_hint' },
{ label: '⌨️ Keyboard shortcuts', next: 'shortcuts_tour' },
{ label: "I'm ready to build!", next: null }
]
},
// ── Technical / nerd path ──────────────────────────────────────────────
tour_canvas_nerd: {
position: 'bottom-left',
hook: 'setup-default',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
"The **graph canvas** renders a directed acyclic graph. Each node is an individual **WASM module** executed in isolation — inputs in, output out. The 3D model updates automatically on every change.\nI've loaded a starter graph so you can see it in action.",
choices: [
{
label: '🔍 Explore Node Sourcecode',
onclick: () => {
window.open(
'https://git.max-richter.dev/max/nodarium/src/branch/main/nodes/max/plantarium',
'__blank'
);
}
}
],
waitFor: 'click',
next: 'tour_viewer_nerd'
},
tour_viewer_nerd: {
position: 'top-left',
highlight: { selector: '.cell:first-child', padding: 8 },
text:
'The **3D viewer** uses `@threlte/core` (Svelte + Three.js). Mesh data streams from WASM execution results. OrbitControls: left-drag rotate, right-drag pan, scroll zoom.',
waitFor: 'click',
next: 'tour_runtime_nerd'
},
tour_runtime_nerd: {
position: 'right',
text:
'By default, nodes execute in a **WebWorker** for better performance. You can switch to main-thread execution by disabling **Debug → Execute in WebWorker** in Settings.\nEnable **Advanced Mode** to unlock the Performance and Benchmark panels.',
waitFor: 'click',
next: 'start_building'
},
// ── Deep dives (shared between paths) ─────────────────────────────────
connections_intro: {
position: 'bottom-right',
text:
'Node sockets are **type-checked**. The coloured dots tell you what kind of data flows through:\n🔵 `number` · 🟢 `vec3` · 🟣 `shape` · ⚪ `*` (wildcard)',
waitFor: 'click',
next: 'connections_rules'
},
connections_rules: {
position: 'right',
text:
'Drag from an output socket to an input socket to connect them.\n• Types must match (or use `*`)\n• No circular loops\n• Optional inputs can stay empty\nInvalid connections snap back automatically.',
choices: [
{ label: '🔧 Node parameters', next: 'params_intro' },
{ label: '🐛 Debug node', next: 'debug_intro' },
{ label: 'Start building!', next: null }
]
},
params_intro: {
position: 'bottom-right',
highlight: { selector: '.graph-wrapper', padding: 12 },
text:
'Click any node to select it. Basic settings are shown **on the node itself**.\nThe sidebar under *Graph Settings → Active Node* shows the full list:\n**Number** — drag or type · **Vec3** — X/Y/Z · **Select** — dropdown · **Color** — picker',
waitFor: 'click',
next: 'params_tip'
},
params_tip: {
position: 'right',
text:
'Pro tips:\n• Parameters can be connected from other nodes — drag an edge to the input socket\n• The **Random Seed** in Graph Settings gives you the same result every run\n• **f** key smart-connects two selected nodes · **Ctrl+Delete** removes a node and restores its edges',
choices: [
{ label: '🔗 How connections work', next: 'connections_intro' },
{ label: '💡 Plant improvement ideas', next: 'improvements_hint' },
{ label: 'Start building!', next: null }
]
},
debug_intro: {
position: 'bottom-right',
text:
'Add a **Debug node** from the Add Menu (Shift+A or right-click). It accepts `*` wildcard inputs — connect any socket to inspect the data flowing through.\nEnable **Advanced Mode** in Settings to also see Performance and Graph Source panels.',
waitFor: 'click',
next: 'debug_done'
},
debug_done: {
position: 'center',
text: 'The Debug node is your best friend when building complex graphs.\nAnything else?',
choices: [
{ label: '🔗 Connection types', next: 'connections_intro' },
{ label: '🔧 Node parameters', next: 'params_intro' },
{ label: 'Start building!', next: null }
]
},
shortcuts_tour: {
position: 'bottom-right',
text:
'**Essential shortcuts:**\n`R` — Regenerate\n`Shift+A` / right-click — Add node\n`f` — Smart-connect selected nodes\n`.` — Center camera\n`Ctrl+Z` / `Ctrl+Y` — Undo / Redo\n`Delete` — Remove selected · `Ctrl+Delete` — Remove and restore edges',
waitFor: 'click',
next: 'shortcuts_done'
},
shortcuts_done: {
position: 'right',
text:
'All shortcuts are also listed in the sidebar under the ⌨️ icon.\nReady to build something?',
choices: [
{ label: '🔗 Node connections', next: 'connections_intro' },
{ label: '🔧 Parameters', next: 'params_intro' },
{ label: "Let's build! 🌿", next: null }
]
},
export_tour: {
position: 'right',
text:
'Export your 3D model from the **📦 Export** panel:\n**GLB** — standard for 3D apps (Blender, Three.js)\n**OBJ** — legacy format · **STL** — 3D printing · **PNG** — screenshot',
waitFor: 'click',
next: 'congrats'
},
improvements_hint: {
position: 'center',
text:
'# Ideas to grow your plant 🌿\n• Add a **Vec3** node → connect to *origin* on the Stem to spread stems across 3D space\n• Use a **Random** node on a parameter so each run produces a unique shape\n• Chain **multiple Stem nodes** with different settings for complex branching\n• Add a **Gravity** or **Branch** node for even more organic results',
choices: [
{ label: '⌨️ Keyboard shortcuts', next: 'shortcuts_tour' },
{ label: "Let's build! 🌿", next: null }
]
}
}
};
+79 -24
View File
@@ -22,13 +22,16 @@
import ExportSettings from '$lib/sidebar/panels/ExportSettings.svelte';
import GraphSource from '$lib/sidebar/panels/GraphSource.svelte';
import Keymap from '$lib/sidebar/panels/Keymap.svelte';
import { panelState } from '$lib/sidebar/PanelState.svelte';
import Sidebar from '$lib/sidebar/Sidebar.svelte';
import { tutorialConfig } from '$lib/tutorial/tutorial-config';
import { Planty } from '@nodarium/planty';
import type { Graph, NodeInstance } from '@nodarium/types';
import { createPerformanceStore } from '@nodarium/utils';
import { onMount } from 'svelte';
import type { Group } from 'three';
let performanceStore = createPerformanceStore();
let planty = $state<ReturnType<typeof Planty>>();
const { data } = $props();
@@ -130,35 +133,65 @@
const handleUpdate = debounceAsyncFunction(update);
onMount(() => {
appSettings.value.debug.stressTest = {
...appSettings.value.debug.stressTest,
loadGrid: () => {
function handleSettingsButton(id: string) {
switch (id) {
case 'general.clippy':
planty?.start();
break;
case 'general.debug.stressTest.loadGrid':
manager.load(
templates.grid(
appSettings.value.debug.stressTest.amount,
appSettings.value.debug.stressTest.amount
)
);
},
loadTree: () => {
break;
case 'general.debug.stressTest.loadTree':
manager.load(templates.tree(appSettings.value.debug.stressTest.amount));
},
lottaFaces: () => {
break;
case 'general.debug.stressTest.lottaFaces':
manager.load(templates.lottaFaces as unknown as Graph);
},
lottaNodes: () => {
break;
case 'general.debug.stressTest.lottaNodes':
manager.load(templates.lottaNodes as unknown as Graph);
},
lottaNodesAndFaces: () => {
break;
case 'general.debug.stressTest.lottaNodesAndFaces':
manager.load(templates.lottaNodesAndFaces as unknown as Graph);
}
};
});
break;
default:
}
}
</script>
<svelte:document onkeydown={applicationKeymap.handleKeyboardEvent} />
<Planty
bind:this={planty}
config={tutorialConfig}
hooks={{
'setup-default': () => {
const ts = new Date().toLocaleTimeString('en-US', { hour: '2-digit', minute: '2-digit' });
pm.handleCreateProject(
structuredClone(templates.defaultPlant) as unknown as Graph,
`Tutorial Project (${ts})`
);
},
'load-tutorial-template': () => {
if (!pm.graph) return;
const g = structuredClone(templates.tutorial) as unknown as Graph;
g.id = pm.graph.id;
g.meta = { ...pm.graph.meta };
pm.graph = g;
pm.saveGraph(g);
},
'before:save_project': () => panelState.setActivePanel('projects'),
'before:export_tour': () => panelState.setActivePanel('exports'),
'before:shortcuts_tour': () => panelState.setActivePanel('shortcuts'),
'after:save_project': () => panelState.setActivePanel('graph-settings'),
'before:tour_runtime_nerd': () => panelState.setActivePanel('general')
}}
/>
<div class="wrapper manager-{manager?.status}">
<header></header>
<Grid.Row>
@@ -192,6 +225,7 @@
<Panel id="general" title="General" icon="i-[tabler--settings]">
<NestedSettings
id="general"
onButtonClick={handleSettingsButton}
bind:value={appSettings.value}
type={AppSettingTypes}
/>
@@ -211,13 +245,15 @@
<Panel id="exports" title="Exporter" icon="i-[tabler--package-export]">
<ExportSettings {scene} />
</Panel>
<Panel
id="node-store"
title="Node Store"
icon="i-[tabler--database] bg-green-400"
>
<NodeStore registry={nodeRegistry} />
</Panel>
{#if false}
<Panel
id="node-store"
title="Node Store"
icon="i-[tabler--database] bg-green-400"
>
<NodeStore registry={nodeRegistry} />
</Panel>
{/if}
<Panel
id="performance"
title="Performance"
@@ -274,6 +310,25 @@
<style>
header {
background-color: var(--color-layer-1);
display: flex;
align-items: center;
padding: 0 8px;
}
.tutorial-btn {
background: none;
border: none;
cursor: pointer;
font-size: 18px;
padding: 4px 6px;
border-radius: 6px;
opacity: 0.7;
transition: opacity 0.15s, background 0.15s;
}
.tutorial-btn:hover {
opacity: 1;
background: rgba(255, 255, 255, 0.08);
}
.wrapper {
@@ -281,7 +336,7 @@
width: 100vw;
color: white;
display: grid;
grid-template-rows: 0px 1fr;
grid-template-rows: 36px 1fr;
}
.wrapper :global(canvas) {
+6
View File
@@ -4,6 +4,7 @@ import { playwright } from '@vitest/browser-playwright';
import comlink from 'vite-plugin-comlink';
import glsl from 'vite-plugin-glsl';
import wasm from 'vite-plugin-wasm';
import path from 'path';
import { defineConfig } from 'vitest/config';
export default defineConfig({
@@ -19,6 +20,11 @@ export default defineConfig({
comlink()
]
},
resolve: {
alias: {
'@nodarium/planty': path.resolve(__dirname, '../packages/planty/src/lib/index.ts')
}
},
ssr: {
noExternal: ['three']
},
+4 -2
View File
@@ -10,12 +10,14 @@
"scale": {
"type": "float",
"min": 0.1,
"max": 10
"max": 10,
"value": 1
},
"strength": {
"type": "float",
"min": 0.1,
"max": 10
"max": 10,
"value": 2
},
"fixBottom": {
"type": "float",
@@ -6,7 +6,7 @@
"inputs": {
"min": {
"type": "float",
"value": 2
"value": 1
},
"max": {
"type": "float",
+1 -1
View File
@@ -9,7 +9,7 @@
"test": "pnpm run -r --parallel test",
"check": "pnpm run -r --parallel check",
"build": "pnpm build:nodes && pnpm build:app",
"build:app": "BASE_PATH=/ui pnpm -r --filter 'ui' build && pnpm -r --filter 'app' build",
"build:app": "BASE_PATH=/ui pnpm -r --filter 'ui' build && pnpm -r --filter 'app'... build",
"build:nodes": "cargo build --workspace --target wasm32-unknown-unknown --release && rm -rf ./app/static/nodes/max/plantarium/ && mkdir -p ./app/static/nodes/max/plantarium/ && cp -R ./target/wasm32-unknown-unknown/release/*.wasm ./app/static/nodes/max/plantarium/",
"dev:nodes": "chokidar './nodes/**' --initial -i '/pkg/' -c 'pnpm build:nodes'",
"dev:app_ui": "pnpm -r --parallel --filter 'app' --filter './packages/ui' dev",
+24
View File
@@ -0,0 +1,24 @@
node_modules
# Output
.output
.vercel
.netlify
.wrangler
/.svelte-kit
/build
/dist
# OS
.DS_Store
Thumbs.db
# Env
.env
.env.*
!.env.example
!.env.test
# Vite
vite.config.js.timestamp-*
vite.config.ts.timestamp-*
+9
View File
@@ -0,0 +1,9 @@
# Package Managers
package-lock.json
pnpm-lock.yaml
yarn.lock
bun.lock
bun.lockb
# Miscellaneous
/static/
+16
View File
@@ -0,0 +1,16 @@
{
"useTabs": true,
"singleQuote": true,
"trailingComma": "none",
"printWidth": 100,
"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
"overrides": [
{
"files": "*.svelte",
"options": {
"parser": "svelte"
}
}
],
"tailwindStylesheet": "./src/routes/layout.css"
}
+65
View File
@@ -0,0 +1,65 @@
# Svelte library
Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
Read more about creating a library [in the docs](https://svelte.dev/docs/kit/packaging).
## Creating a project
If you're seeing this, you've probably already done this step. Congrats!
```sh
# create a new project in the current directory
npx sv create
# create a new project in my-app
npx sv create my-app
```
To recreate this project with the same configuration:
```sh
# recreate this project
pnpm dlx sv@0.15.1 create --template library --types ts --add prettier eslint tailwindcss="plugins:none" --install pnpm planty
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```sh
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
Everything inside `src/lib` is part of your library, everything inside `src/routes` can be used as a showcase or preview app.
## Building
To build your library:
```sh
npm pack
```
To create a production version of your showcase app:
```sh
npm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
## Publishing
Go into the `package.json` and give your package the desired name through the `"name"` option. Also consider adding a `"license"` field and point it to a `LICENSE` file which you can create from a template (one popular option is the [MIT license](https://opensource.org/license/mit/)).
To publish your library to [npm](https://www.npmjs.com):
```sh
npm publish
```
+44
View File
@@ -0,0 +1,44 @@
import prettier from 'eslint-config-prettier';
import path from 'node:path';
import { includeIgnoreFile } from '@eslint/compat';
import js from '@eslint/js';
import svelte from 'eslint-plugin-svelte';
import { defineConfig } from 'eslint/config';
import globals from 'globals';
import ts from 'typescript-eslint';
import svelteConfig from './svelte.config.js';
const gitignorePath = path.resolve(import.meta.dirname, '.gitignore');
export default defineConfig(
includeIgnoreFile(gitignorePath),
js.configs.recommended,
ts.configs.recommended,
svelte.configs.recommended,
prettier,
svelte.configs.prettier,
{
languageOptions: { globals: { ...globals.browser, ...globals.node } },
rules: {
// typescript-eslint strongly recommend that you do not use the no-undef lint rule on TypeScript projects.
// see: https://typescript-eslint.io/troubleshooting/faqs/eslint/#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
'no-undef': 'off'
}
},
{
files: ['**/*.svelte', '**/*.svelte.ts', '**/*.svelte.js'],
languageOptions: {
parserOptions: {
projectService: true,
extraFileExtensions: ['.svelte'],
parser: ts.parser,
svelteConfig
}
}
},
{
// Override or add rule settings here, such as:
// 'svelte/button-has-type': 'error'
rules: {}
}
);
+63
View File
@@ -0,0 +1,63 @@
{
"name": "@nodarium/planty",
"version": "0.0.1",
"scripts": {
"dev": "vite dev",
"build": "vite build && npm run prepack",
"preview": "vite preview",
"prepare": "svelte-kit sync || echo ''",
"prepack": "svelte-kit sync && svelte-package && publint",
"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
"lint": "prettier --check . && eslint .",
"format": "prettier --write ."
},
"files": [
"dist",
"!dist/**/*.test.*",
"!dist/**/*.spec.*"
],
"sideEffects": [
"**/*.css"
],
"svelte": "./dist/index.js",
"types": "./dist/index.d.ts",
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"svelte": "./dist/index.js"
}
},
"peerDependencies": {
"svelte": "^5.0.0"
},
"devDependencies": {
"@nodarium/ui": "workspace:*",
"@eslint/compat": "^2.0.4",
"@eslint/js": "^10.0.1",
"@sveltejs/adapter-auto": "^7.0.1",
"@sveltejs/kit": "^2.57.0",
"@sveltejs/package": "^2.5.7",
"@sveltejs/vite-plugin-svelte": "^7.0.0",
"@tailwindcss/vite": "^4.2.2",
"@types/node": "^24",
"eslint": "^10.2.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-svelte": "^3.17.0",
"globals": "^17.4.0",
"prettier": "^3.8.1",
"prettier-plugin-svelte": "^3.5.1",
"prettier-plugin-tailwindcss": "^0.7.2",
"publint": "^0.3.18",
"svelte": "^5.55.2",
"svelte-check": "^4.4.6",
"tailwindcss": "^4.2.2",
"typescript": "^6.0.2",
"typescript-eslint": "^8.58.1",
"vite": "^8.0.7"
},
"keywords": [
"svelte"
]
}
+13
View File
@@ -0,0 +1,13 @@
// See https://svelte.dev/docs/kit/types#app.d.ts
// for information about these interfaces
declare global {
namespace App {
// interface Error {}
// interface Locals {}
// interface PageData {}
// interface PageState {}
// interface Platform {}
}
}
export {};
+13
View File
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en" class="theme-dark">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%sveltekit.assets%/favicon.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="text-scale" content="scale" />
%sveltekit.head%
</head>
<body data-sveltekit-preload-data="hover">
<div style="display: contents">%sveltekit.body%</div>
</body>
</html>
@@ -0,0 +1,110 @@
<script lang="ts">
import type { PlantyHook } from '../types.js';
interface Props {
selector?: string;
hookName?: string;
hooks?: Record<string, PlantyHook>;
}
let { selector, hookName, hooks = {} }: Props = $props();
let rect = $state<{ top: number; left: number; width: number; height: number } | null>(null);
$effect(() => {
let el: Element | null = null;
let ro: ResizeObserver | null = null;
let mo: MutationObserver | null = null;
function resolveEl(): Element | null {
if (selector) return document.querySelector(selector);
if (hookName && hooks[hookName]) {
const result = hooks[hookName]();
if (result instanceof Element) return result;
}
return null;
}
function updateRect() {
if (!el) {
rect = null;
return;
}
const raw = el.getBoundingClientRect();
const vw = window.innerWidth;
const vh = window.innerHeight;
const p = 4;
const top = Math.max(p, raw.top - p);
const left = Math.max(p, raw.left - p);
const right = Math.min(vw - p, raw.right + p);
const bottom = Math.min(vh - p, raw.bottom + p);
if (right <= left || bottom <= top) {
rect = null;
return;
}
rect = { top, left, width: right - left, height: bottom - top };
}
function attachEl(newEl: Element | null) {
if (newEl === el) return;
ro?.disconnect();
el = newEl;
if (!el) {
rect = null;
return;
}
updateRect();
ro = new ResizeObserver(updateRect);
ro.observe(el);
}
attachEl(resolveEl());
window.addEventListener('scroll', updateRect, { passive: true, capture: true });
window.addEventListener('resize', updateRect, { passive: true });
// For hook-based highlights, watch the DOM so we catch dynamically added elements
if (hookName) {
mo = new MutationObserver(() => attachEl(resolveEl()));
mo.observe(document.body, { childList: true, subtree: true });
}
return () => {
ro?.disconnect();
mo?.disconnect();
window.removeEventListener('scroll', updateRect, true);
window.removeEventListener('resize', updateRect);
};
});
</script>
{#if rect}
<div
class="highlight fixed z-99999 rounded-md pointer-events-none"
style:top="{rect.top}px"
style:left="{rect.left}px"
style:width="{rect.width}px"
style:height="{rect.height}px"
>
</div>
{/if}
<style>
@keyframes pulse {
0%, 100% {
box-shadow:
0 0 0 9999px rgba(0, 0, 0, 0.45),
0 0 0 2px rgba(255, 255, 255, 0.9),
0 0 16px rgba(255, 255, 255, 0.3);
}
50% {
box-shadow:
0 0 0 9999px rgba(0, 0, 0, 0.45),
0 0 0 2px rgba(255, 255, 255, 1),
0 0 28px rgba(255, 255, 255, 0.6);
}
}
.highlight {
animation: pulse 1.8s ease-in-out infinite;
}
</style>
@@ -0,0 +1,222 @@
<script lang="ts">
import { DialogRunner } from '../dialog-runner.js';
import type { AvatarPosition, DialogNode, PlantyConfig, PlantyHook } from '../types.js';
import Highlight from './Highlight.svelte';
import PlantyAvatar from './PlantyAvatar.svelte';
import type { Mood } from './PlantyAvatar.svelte';
import SpeechBubble from './SpeechBubble.svelte';
interface Props {
config: PlantyConfig;
hooks?: Record<string, PlantyHook>;
onStepChange?: (nodeId: string, node: DialogNode) => void;
onComplete?: () => void;
}
let {
config,
hooks = {},
onStepChange,
onComplete
}: Props = $props();
const AVATAR_SIZE = 80;
const SCREEN_PADDING = 20;
// ── State ────────────────────────────────────────────────────────────
let isActive = $state(false);
let currentNodeId = $state<string | null>(null);
let bubbleVisible = $state(false);
let avatarX = $state(0);
let avatarY = $state(0);
let mood = $state<Mood>('idle');
let autoAdvanceTimer: ReturnType<typeof setTimeout> | null = null;
let actionCleanup: (() => void) | null = null;
// ── Derived ──────────────────────────────────────────────────────────
const runner = $derived(new DialogRunner(config));
const mainPath = $derived(runner.getMainPath());
const currentNode = $derived<DialogNode | null>(
currentNodeId ? runner.getNode(currentNodeId) : null
);
const showBubble = $derived(
isActive && bubbleVisible && currentNode !== null && !!currentNode.text
);
const highlight = $derived(currentNode?.highlight ?? null);
const stepIndex = $derived(currentNodeId ? mainPath.indexOf(currentNodeId) : -1);
const totalSteps = $derived(mainPath.length);
// ── Position helpers ─────────────────────────────────────────────────
function anchorToCoords(anchor: string): { x: number; y: number } {
const w = window.innerWidth;
const h = window.innerHeight;
switch (anchor) {
case 'top-left':
return { x: SCREEN_PADDING, y: SCREEN_PADDING };
case 'top-right':
return { x: w - AVATAR_SIZE - SCREEN_PADDING, y: SCREEN_PADDING };
case 'bottom-left':
return { x: SCREEN_PADDING, y: h - AVATAR_SIZE - SCREEN_PADDING };
case 'center':
return { x: (w - AVATAR_SIZE) / 2, y: (h - AVATAR_SIZE) / 2 };
case 'right':
return { x: w - AVATAR_SIZE - SCREEN_PADDING, y: (h - AVATAR_SIZE) / 2 };
case 'bottom-right':
default:
return { x: w - AVATAR_SIZE - SCREEN_PADDING, y: h - AVATAR_SIZE - SCREEN_PADDING };
}
}
function resolvePosition(pos: AvatarPosition): { x: number; y: number } {
return typeof pos === 'string' ? anchorToCoords(pos) : pos;
}
// ── Public API (exposed via bind:this) ───────────────────────────────
export function start() {
const defaultPos = config.avatar?.defaultPosition ?? 'bottom-right';
const pos = resolvePosition(defaultPos);
avatarX = pos.x;
avatarY = pos.y;
isActive = true;
const start = runner.getStartNode();
if (start) _enterNode(start.id, start.node);
}
export function stop() {
_clearAutoAdvance();
isActive = false;
bubbleVisible = false;
currentNodeId = null;
mood = 'idle';
onComplete?.();
}
export async function next() {
if (!currentNodeId) return;
await _runAfter(currentNodeId, currentNode);
const next = runner.getNextNode(currentNodeId);
if (next) _enterNode(next.id, next.node);
else stop();
}
export function registerHook(name: string, fn: PlantyHook) {
hooks = { ...hooks, [name]: fn };
}
// ── Internal ─────────────────────────────────────────────────────────
async function _runAfter(nodeId: string, node: DialogNode | null) {
if (!node) return;
if (actionCleanup) {
actionCleanup();
actionCleanup = null;
}
await node.after?.(nodeId, node);
await hooks[`after:${nodeId}`]?.(nodeId, node);
}
async function _enterNode(id: string, node: DialogNode) {
_clearAutoAdvance();
bubbleVisible = false;
currentNodeId = id;
onStepChange?.(id, node);
// Before hooks — run before movement starts
await node.before?.(id, node);
await hooks[`before:${id}`]?.(id, node);
// Fly to position first, then talk
if (node.position) {
mood = 'moving';
const pos = resolvePosition(node.position);
avatarX = pos.x;
avatarY = pos.y;
await _wait(900);
}
mood = 'talking';
bubbleVisible = true;
// App hook
if (node.hook && hooks[node.hook]) {
const result = await hooks[node.hook](...(node.hookArgs ?? []));
if (typeof result === 'function') actionCleanup = result as () => void;
}
// Auto-advance
if (typeof node.waitFor === 'number') {
autoAdvanceTimer = setTimeout(() => next(), node.waitFor);
}
if (node.waitFor === 'action') {
const actionHook = hooks[`action:${id}`];
if (actionHook) {
const advance = () => next();
const result = await actionHook(advance, ...(node.hookArgs ?? []));
if (typeof result === 'function') actionCleanup = result as () => void;
}
}
if (!node.choices && !node.next) {
setTimeout(() => stop(), 3000);
}
// Stay in talking mood until the typewriter finishes (26 ms/char + buffer)
const talkMs = (node.text?.length ?? 0) * 26 + 200;
setTimeout(() => {
mood = 'idle';
}, talkMs);
}
function _wait(ms: number) {
return new Promise<void>((r) => setTimeout(r, ms));
}
function _clearAutoAdvance() {
if (autoAdvanceTimer !== null) {
clearTimeout(autoAdvanceTimer);
autoAdvanceTimer = null;
}
}
</script>
{#if isActive}
<div class="pointer-events-none fixed inset-0 z-99999">
{#if highlight}
<Highlight
selector={highlight.selector}
hookName={highlight.hookName}
{hooks}
/>
{/if}
<PlantyAvatar bind:x={avatarX} bind:y={avatarY} {mood} />
{#if showBubble && currentNode}
<SpeechBubble
text={currentNode.text ?? ''}
{avatarX}
{avatarY}
choices={currentNode.choices || []}
showNext={currentNode.waitFor === 'click'}
{stepIndex}
{totalSteps}
onNext={next}
onClose={stop}
onChoose={async (choice) => {
await _runAfter(currentNodeId!, currentNode);
if (choice && choice.onclick) {
choice.onclick();
return;
}
if (!choice.next) {
stop();
return;
}
const n = runner.followChoice(choice);
if (n) _enterNode(n.id, n.node);
else stop();
}}
/>
{/if}
</div>
{/if}
@@ -0,0 +1,319 @@
<script lang="ts">
import { scale } from 'svelte/transition';
export type Mood = 'idle' | 'talking' | 'happy' | 'thinking' | 'moving';
interface Props {
x: number;
y: number;
mood?: Mood;
}
let { x = $bindable(0), y = $bindable(0), mood = 'idle' }: Props = $props();
// ── Drag ─────────────────────────────────────────────────────────────
let dragging = $state(false);
let dragOffsetX = 0;
let dragOffsetY = 0;
function onPointerDown(e: PointerEvent) {
if (e.button !== 0) return;
dragging = true;
dragOffsetX = e.clientX - x;
dragOffsetY = e.clientY - y;
(e.currentTarget as HTMLElement).setPointerCapture(e.pointerId);
e.preventDefault();
e.stopPropagation();
}
function onPointerMove(e: PointerEvent) {
if (!dragging) return;
x = Math.max(Math.min(e.clientX - dragOffsetX, window.innerWidth - 45), 5);
y = Math.max(Math.min(e.clientY - dragOffsetY, window.innerHeight - 75), 5);
}
function onPointerUp() {
dragging = false;
}
const displayMood = $derived(dragging ? 'moving' : mood);
let mouthOpen = $state(false);
$effect(() => {
if (displayMood !== 'talking') {
mouthOpen = false;
return;
}
const id = setInterval(() => {
mouthOpen = !mouthOpen;
}, 180);
return () => clearInterval(id);
});
const MOUTH_DOWN =
'M29.5 55L28 63L23 68.5L14 70.5L6.5 66L4 58.5L10.5 29L15 24H24L28 29.5L28.5 34L23 58L16.5 61.5L10.5 59.5L8.5 53.5';
const MOUTH_UP =
'M29.5 55L28 63L23 68.5L14 70.5L6.5 66L4 58.5L10.5 29L15 24H24L28 29.5L28.5 34L24 56.5L17.5 60L11.5 58L9.5 52';
const bodyPath = $derived(
(displayMood === 'talking' && mouthOpen) || displayMood === 'happy' ? MOUTH_DOWN : MOUTH_UP
);
// ── Cursor-tracking pupils ────────────────────────────────────────────
// Avatar screen positions of each eye centre (SVG natural size 46×74)
let cursorX = $state(-9999);
let cursorY = $state(-9999);
function onMouseMove(e: MouseEvent) {
cursorX = e.clientX;
cursorY = e.clientY;
}
function pupilOffset(cx: number, cy: number, eyeSvgX: number, eyeSvgY: number, maxPx = 2.8) {
const ex = x + eyeSvgX;
const ey = y + eyeSvgY;
const dx = cx - ex;
const dy = cy - ey;
const dist = Math.sqrt(dx * dx + dy * dy);
if (dist < 1) return { px: 0, py: 0 };
// Ramp up to full offset over 120px of distance
const t = Math.min(dist, 120) / 120;
return { px: (dx / dist) * maxPx * t, py: (dy / dist) * maxPx * t };
}
const left = $derived(
displayMood === 'talking'
? { px: 0, py: 0 }
: pupilOffset(cursorX, cursorY, 9.5, 30.5)
);
const right = $derived(
displayMood === 'talking'
? { px: 0, py: 0 }
: pupilOffset(cursorX, cursorY, 31.5, 35.5)
);
</script>
<svelte:window onmousemove={onMouseMove} />
<div
class="avatar"
role="button"
tabindex="0"
in:scale={{ duration: 400, delay: 300 }}
class:mood-idle={displayMood === 'idle'}
class:mood-thinking={displayMood === 'thinking'}
class:mood-talking={displayMood === 'talking'}
class:mood-happy={displayMood === 'happy'}
class:mood-moving={displayMood === 'moving'}
class:dragging
style:left="{x}px"
style:top="{y}px"
onpointerdown={onPointerDown}
onpointermove={onPointerMove}
onpointerup={onPointerUp}
>
<svg
width="46"
height="74"
viewBox="0 0 46 74"
fill="none"
xmlns="http://www.w3.org/2000/svg"
overflow="visible"
>
<!--
Leaf hinge points (transform-box: fill-box):
leave-right → origin 0% 100% (bottom-left of bbox)
leave-left → origin 100% 100% (bottom-right of bbox)
-->
<g class="leave-right">
<path
d="M26.9781 16.5596L22.013 23.2368L22.8082 25.306L35.2985 25.3849L43.7783 20.6393L45.8723 14.8213L35.7374 14.0864L26.9781 16.5596Z"
fill="#4F7B41"
/>
<path
d="M27 16.5L22.013 23.2368L22.8082 25.306L29 21L36.5 17L45.8723 14.8213L36 14L27 16.5Z"
fill="#406634"
/>
</g>
<g class="leave-left">
<path
d="M11.3107 19.2204L17.7636 24.7215L20.3207 25.3703L22.8257 13.0024L19.0993 2.99176L12.5794 1.95314e-05L10.0997 9.77364L11.3107 19.2204Z"
fill="#4F7B41"
/>
<path
d="M11.3107 19.2204L17.7636 24.7215L20.3207 25.3703L16 17L13.5 8L12.5794 1.95314e-05L10.0997 9.77364L11.3107 19.2204Z"
fill="#5E8751"
/>
</g>
<path class="body" d={bodyPath} stroke="#4F7B41" stroke-width="3" />
<!-- Left eye — pupils translated toward cursor -->
<g class="eye-left">
<circle cx="9.5" cy="30.5" r="9.5" fill="white" />
<g transform="translate({left.px} {left.py})">
<circle class="pupil" cx="9.5" cy="30.5" r="6.5" fill="black" />
<circle cx="10.5" cy="27.5" r="2.5" fill="white" />
</g>
</g>
<!-- Right eye — pupils translated toward cursor -->
<g class="eye-right">
<circle cx="31.5" cy="35.5" r="9.5" fill="white" />
<g transform="translate({right.px} {right.py})">
<circle class="pupil" cx="30.5" cy="34.5" r="6.5" fill="black" />
<circle cx="30.5" cy="31.5" r="2.5" fill="white" />
</g>
</g>
</svg>
</div>
<style>
/* ── Wrapper ─────────────────────────────────────────────────────── */
.avatar {
position: absolute;
cursor: grab;
user-select: none;
pointer-events: auto;
filter: drop-shadow(0px 0px 10px black);
transition:
left 0.85s cubic-bezier(0.33, 1, 0.68, 1),
top 0.85s cubic-bezier(0.33, 1, 0.68, 1),
}
.dragging {
cursor: grabbing;
transition: none;
}
/* idle: steady vertical bob */
@keyframes bob {
0%, 100% { transform: translateY(0); }
50% { transform: translateY(-5px); }
}
.mood-idle { animation: bob 2.6s ease-in-out infinite; }
.mood-happy { animation: bob 1.8s ease-in-out infinite; }
/* thinking: head tilted to the side — clearly different from idle */
@keyframes think {
0%, 100% { transform: rotate(-12deg) translateY(0); }
50% { transform: rotate(-12deg) translateY(-3px); }
}
.mood-thinking { animation: think 2.8s ease-in-out infinite; }
/* talking: subtle head waggle */
@keyframes waggle {
0%, 100% { transform: rotate(0deg); }
25% { transform: rotate(-2deg) translateY(-1px); }
75% { transform: rotate(2deg) translateY(1px); }
}
.mood-talking { animation: waggle 0.3s ease-in-out infinite; }
/* moving: forward-lean glide */
@keyframes glide {
0%, 100% { transform: translateY(0) rotate(-6deg); }
50% { transform: translateY(-8px) rotate(-4deg); }
}
.mood-moving { animation: glide 0.4s ease-in-out infinite; }
/* ── Drop shadows ────────────────────────────────────────────────── */
.body {
filter: drop-shadow(1px 1px 0 rgba(0, 0, 0, 0.5));
transition: d 0.12s ease-in-out;
}
.eye-left, .eye-right {
filter: drop-shadow(1px 1px 0 rgba(0, 0, 0, 0.5));
}
.mood-talking {
.eye-left, .eye-right {
> g {
transition: transform 0.5s ease-in-out;
}
}
}
/* ── Leaves ──────────────────────────────────────────────────────── */
.leave-right {
transform-box: fill-box;
transform-origin: 0% 100%;
}
.leave-left {
transform-box: fill-box;
transform-origin: 100% 100%;
}
/* idle: slow gentle breathing wave */
@keyframes idle-right {
0%, 100% { transform: rotate(0deg); }
50% { transform: rotate(-9deg); }
}
@keyframes idle-left {
0%, 100% { transform: rotate(0deg); }
50% { transform: rotate(7deg); }
}
.mood-idle .leave-right { animation: idle-right 3s ease-in-out infinite; }
.mood-idle .leave-left { animation: idle-left 3s ease-in-out infinite 0.15s; }
/* thinking: wings held raised, minimal drift */
@keyframes think-right {
0%, 100% { transform: rotate(-14deg); }
50% { transform: rotate(-10deg); }
}
@keyframes think-left {
0%, 100% { transform: rotate(10deg); }
50% { transform: rotate(7deg); }
}
.mood-thinking .leave-right { animation: think-right 4s ease-in-out infinite; }
.mood-thinking .leave-left { animation: think-left 4s ease-in-out infinite 0.3s; }
/* talking: nearly still — tiny passive counter-sway */
@keyframes talk-right {
0%, 100% { transform: rotate(-2deg); }
50% { transform: rotate(2deg); }
}
@keyframes talk-left {
0%, 100% { transform: rotate(2deg); }
50% { transform: rotate(-2deg); }
}
.mood-talking .leave-right { animation: talk-right 0.6s ease-in-out infinite; }
.mood-talking .leave-left { animation: talk-left 0.6s ease-in-out infinite 0.1s; }
/* happy: light casual flap */
@keyframes happy-right {
0%, 100% { transform: rotate(0deg); }
50% { transform: rotate(-18deg); }
}
@keyframes happy-left {
0%, 100% { transform: rotate(0deg); }
50% { transform: rotate(13deg); }
}
.mood-happy .leave-right { animation: happy-right 1.4s ease-in-out infinite; }
.mood-happy .leave-left { animation: happy-left 1.4s ease-in-out infinite 0.1s; }
/* moving: vigorous wing flap — full range, fast */
@keyframes flap-right {
0%, 100% { transform: rotate(0deg); }
40% { transform: rotate(-40deg); }
}
@keyframes flap-left {
0%, 100% { transform: rotate(0deg); }
40% { transform: rotate(26deg); }
}
.mood-moving .leave-right { animation: flap-right 0.34s ease-in-out infinite; }
.mood-moving .leave-left { animation: flap-left 0.34s ease-in-out infinite 0.04s; }
/* ── Eye blink (on pupil so it doesn't fight cursor translate) ───── */
@keyframes blink {
0%, 93%, 100% { transform: scaleY(1); }
96% { transform: scaleY(0.05); }
}
.pupil {
transform-box: fill-box;
transform-origin: center;
animation: blink 4s ease-in-out infinite;
}
.eye-left .pupil { animation-delay: 0s; }
.eye-right .pupil { animation-delay: 0.07s; }
</style>
@@ -0,0 +1,167 @@
<script lang="ts">
import { fade } from 'svelte/transition';
import type { Choice } from '../types.js';
interface Props {
text: string;
avatarX: number;
avatarY: number;
choices?: Choice[];
showNext?: boolean;
stepIndex?: number;
totalSteps?: number;
onNext?: () => void;
onClose?: () => void;
onChoose?: (choice: Choice) => void;
}
let {
text,
avatarX,
avatarY,
choices = [],
showNext = false,
stepIndex = -1,
totalSteps = 0,
onNext,
onClose,
onChoose
}: Props = $props();
const showProgress = $derived(stepIndex >= 0 && totalSteps > 0);
const BUBBLE_WIDTH = 268;
const AVATAR_SIZE = 80;
const GAP = 10;
const isAvatarNearTop = $derived(avatarY < BUBBLE_WIDTH + GAP + 8);
const left = $derived(Math.max(8, Math.min(avatarX, window.innerWidth - BUBBLE_WIDTH - 8)));
const bottom = $derived(isAvatarNearTop ? null : `${window.innerHeight - avatarY + GAP}px`);
const top = $derived(isAvatarNearTop ? `${avatarY + AVATAR_SIZE + GAP}px` : null);
// Typewriter
let displayed = $state('');
const finished = $derived(displayed.length === text.length);
let typeTimer: ReturnType<typeof setTimeout> | null = null;
function renderMarkdown(raw: string): string {
return raw
.replaceAll(/^# (.+)$/gm, '<strong class="block text-sm font-bold mb-1">$1</strong>')
.replaceAll(/\*\*(.+?)\*\*/g, '<strong>$1</strong>')
.replaceAll(/\*(.+?)\*/g, '<em>$1</em>')
.replaceAll(
/`(.+?)`/g,
'<code class="text-[11px] rounded px-1 font-mono" style="background: var(--color-layer-3); color: var(--color-text);">$1</code>'
)
.replaceAll(/\*/, '')
.replaceAll(/\_/, '')
.replaceAll(/\n+/g, '<br>');
}
$effect(() => {
// Track only `text` as a dependency.
// Never read `displayed` inside the effect — += would add it as a dep
// and cause an infinite loop. Use slice(0, i) for pure writes instead.
const target = text;
displayed = '';
if (typeTimer) clearTimeout(typeTimer);
let i = 0;
function tick() {
if (i < target.length) {
displayed = target.slice(0, ++i);
typeTimer = setTimeout(tick, 26);
} else {
}
}
// Defer first tick so no reads happen during the synchronous effect body
typeTimer = setTimeout(tick, 0);
return () => {
if (typeTimer) clearTimeout(typeTimer);
};
});
</script>
<div
class="fixed p-2 z-99999 pointer-events-auto rounded-md border"
style:width="{BUBBLE_WIDTH}px"
style:left="{left}px"
style:bottom={bottom}
style:top={top}
style:background="var(--color-layer-0)"
style:border-color="var(--color-outline)"
>
{#if isAvatarNearTop}
<!-- Tail pointing up toward avatar -->
<div
class="absolute -top-2 h-3.5 w-3.5 rotate-45 border-t border-l"
style:left="{Math.min(Math.max(avatarX - left + AVATAR_SIZE / 2 - 25, 12), BUBBLE_WIDTH - 28)}px"
style:background="var(--color-layer-0)"
style:border-color="var(--color-outline)"
>
</div>
{:else}
<!-- Tail pointing down toward avatar -->
<div
class="absolute -bottom-2 h-3.5 w-3.5 rotate-45 border-b border-r"
style:left="{Math.min(Math.max(avatarX - left + AVATAR_SIZE / 2 - 25, 12), BUBBLE_WIDTH - 28)}px"
style:background="var(--color-layer-0)"
style:border-color="var(--color-outline)"
>
</div>
{/if}
<!-- svelte-ignore a11y_no_static_element_interactions -->
<div class="mb-2 min-h-[1.4em] text-sm leading-relaxed" style="color: var(--color-text)">
{@html renderMarkdown(displayed)}
</div>
{#if choices.length > 0}
<div class="flex flex-col gap-1.5">
{#each choices as choice, i}
{#if finished}
<button
in:fade={{ duration: 200, delay: i * 250 }}
class="rounded-lg px-3 py-1.5 text-left text-sm font-medium transition-colors cursor-pointer"
style:background="var(--color-layer-1)"
style:border-color="var(--color-outline)"
style:color="var(--color-text)"
onclick={() => onChoose?.(choice)}
>
{choice.label}
</button>
{/if}
{/each}
</div>
{/if}
<div class="flex items-center justify-between gap-2 mt-2">
<button
class="text-xs transition-colors cursor-pointer"
style="color: var(--color-outline)"
onclick={onClose}
>
✕ close
</button>
<div class="flex items-center gap-2">
{#if showProgress}
<span class="text-xs tabular-nums" style="color: var(--color-outline)">
{stepIndex + 1} / {totalSteps}
</span>
{/if}
{#if showNext && finished}
<button
class="rounded-lg px-3 py-1 text-xs font-semibold cursor-pointer transition-colors"
style:background="var(--color-outline)"
style:color="var(--color-layer-0)"
onclick={onNext}
>
Next →
</button>
{/if}
</div>
</div>
</div>
+52
View File
@@ -0,0 +1,52 @@
import type { Choice, DialogNode, PlantyConfig } from './types.js';
export class DialogRunner {
private config: PlantyConfig;
constructor(config: PlantyConfig) {
this.config = config;
}
getNode(id: string): DialogNode | null {
return this.config.nodes[id] ?? null;
}
getStartNode(): { id: string; node: DialogNode } | null {
const node = this.getNode(this.config.start);
if (!node) return null;
return { id: this.config.start, node };
}
getNextNode(currentId: string): { id: string; node: DialogNode } | null {
const current = this.getNode(currentId);
if (!current) return null;
if (!current.next) return null;
const next = this.getNode(current.next);
if (!next) return null;
return { id: current.next, node: next };
}
followChoice(choice: Choice): { id: string; node: DialogNode } | null {
if (!choice.next) return null;
const node = this.getNode(choice.next);
if (!node) return null;
return { id: choice.next, node };
}
/** Walk the main path (first choice for choice nodes) and return all node IDs. */
getMainPath(): string[] {
const path: string[] = [];
const visited = new Set<string>();
let id: string | null = this.config.start;
while (id && !visited.has(id)) {
visited.add(id);
path.push(id);
const node = this.getNode(id);
if (!node) break;
const next = node.choices?.[0]?.next ?? node.next;
if (next) id = next;
else break;
}
return path;
}
}
+11
View File
@@ -0,0 +1,11 @@
export { default as Planty } from './components/Planty.svelte';
export type {
AvatarAnchor,
AvatarPosition,
Choice,
DialogNode,
HighlightTarget,
PlantyConfig,
PlantyHook,
StepCallback
} from './types.js';
+66
View File
@@ -0,0 +1,66 @@
import type { DialogNode, StepCallback } from './types.js';
/**
* Cross-module step hook registry.
*
* Create one shared instance and import it wherever you need to react to
* Planty steps — no reference to the <Planty> component required.
*
* @example
* // tutorial-steps.ts
* export const steps = createPlantySteps();
*
* // graph-editor.ts
* steps.before('highlight_graph', () => graphEditor.setHighlight(true));
* steps.after ('highlight_graph', () => graphEditor.setHighlight(false));
*
* // +page.svelte
* <Planty {config} {steps} />
*/
export class PlantySteps {
private _before = new Map<string, StepCallback[]>();
private _after = new Map<string, StepCallback[]>();
/** Register a handler to run before `nodeId` becomes active. Chainable. */
before(nodeId: string, fn: StepCallback): this {
const list = this._before.get(nodeId) ?? [];
this._before.set(nodeId, [...list, fn]);
return this;
}
/** Register a handler to run after the user leaves `nodeId`. Chainable. */
after(nodeId: string, fn: StepCallback): this {
const list = this._after.get(nodeId) ?? [];
this._after.set(nodeId, [...list, fn]);
return this;
}
/** Remove all handlers for a node (or all nodes if omitted). */
clear(nodeId?: string) {
if (nodeId) {
this._before.delete(nodeId);
this._after.delete(nodeId);
} else {
this._before.clear();
this._after.clear();
}
}
/** @internal — called by Planty */
async runBefore(nodeId: string, node: DialogNode): Promise<void> {
for (const fn of this._before.get(nodeId) ?? []) {
await fn(nodeId, node);
}
}
/** @internal — called by Planty */
async runAfter(nodeId: string, node: DialogNode): Promise<void> {
for (const fn of this._after.get(nodeId) ?? []) {
await fn(nodeId, node);
}
}
}
export function createPlantySteps(): PlantySteps {
return new PlantySteps();
}
+58
View File
@@ -0,0 +1,58 @@
export type AvatarAnchor =
| 'top-left'
| 'top-right'
| 'bottom-left'
| 'bottom-right'
| 'center'
| 'right';
export type AvatarPosition = { x: number; y: number } | AvatarAnchor;
export interface HighlightTarget {
/** CSS selector for the element to highlight */
selector?: string;
/** Name of an app-registered hook that returns Element | null */
hookName?: string;
/** Extra space around the element in px */
padding?: number;
}
export interface DialogNode {
text?: string;
position?: AvatarPosition;
highlight?: HighlightTarget;
/** App hook to call on entering this node */
hook?: string;
hookArgs?: unknown[];
next?: string | null;
choices?: Choice[];
/** 'click' = wait for user click, number = auto-advance after N ms, 'action' = wait for hook to call advance() */
waitFor?: 'click' | 'action' | number;
/** Called (and awaited) just before the avatar starts moving to this node */
before?: StepCallback;
/** Called (and awaited) just before the user leaves this node */
after?: StepCallback;
}
export interface Choice {
label: string;
next: string | null;
onclick?: () => void;
}
export interface PlantyConfig {
id: string;
avatar?: {
name?: string;
defaultPosition?: AvatarPosition;
};
start: string;
nodes: Record<string, DialogNode>;
}
export type PlantyHook = (
...args: unknown[]
) => void | Element | null | Promise<void> | (() => void);
/** Called before/after a node becomes active. Async-safe. */
export type StepCallback = (nodeId: string, node: DialogNode) => void | Promise<void>;
@@ -0,0 +1,8 @@
<script lang="ts">
import '@nodarium/ui/app.css';
import './layout.css';
const { children } = $props();
</script>
{@render children()}
+142
View File
@@ -0,0 +1,142 @@
<script lang="ts">
import Planty from '$lib/components/Planty.svelte';
import PlantyAvatar, { type Mood } from '$lib/components/PlantyAvatar.svelte';
import type { PlantyConfig } from '$lib/types.js';
import { onMount } from 'svelte';
import ThemeSelector from './ThemeSelector.svelte';
let plantyConfig = $state<PlantyConfig | null>(null);
let planty: ReturnType<typeof Planty> | undefined = $state();
let started = $state(false);
// Avatar preview state
const moods: Mood[] = ['idle', 'talking', 'happy', 'thinking', 'moving'];
let previewMood = $state<Mood>('idle');
onMount(async () => {
const res = await fetch('/demo-tutorial.json');
plantyConfig = await res.json();
});
function startTour() {
planty?.start();
started = true;
}
</script>
<svelte:head>
<title>Planty — Demo</title>
</svelte:head>
<div
class="grid min-h-screen grid-rows-[auto_1fr]"
style="background-color: var(--color-layer-0); color: var(--color-text);"
>
<!-- Header -->
<header
class="flex items-center gap-4 px-8 py-5 h-12"
style="border-color: var(--color-outline);"
>
<h1 class="text-xl font-semibold">🌿 Planty</h1>
<span
class="rounded-full px-2 py-0.5 text-xs font-bold"
style="background: var(--color-layer-3); color: var(--color-layer-0);"
>demo</span>
<ThemeSelector />
<button
class="ml-auto rounded-xl px-5 py-2 text-sm font-bold transition hover:scale-95 active:scale-95"
style="background: var(--color-layer-3); color: var(--color-layer-0);"
onclick={startTour}
disabled={started || !plantyConfig}
>
{started ? 'Tour running…' : 'Start tutorial'}
</button>
</header>
<!-- App layout -->
<main class="grid grid-cols-[1fr_280px]">
<!-- Graph canvas -->
<div
id="graph-canvas"
class="relative flex min-h-125 items-center justify-center"
style="background-color: var(--color-layer-1); background-image: radial-gradient(circle, var(--color-outline) 1px, transparent 1px); background-size: 24px 24px;"
>
<p class="text-center text-sm" style="color: var(--color-outline);">
Node graph canvas<br />
<span style="opacity: 0.6;">(click "Start tutorial" above)</span>
</p>
<!-- Avatar mood preview (bottom of canvas) -->
<div class="absolute bottom-6 left-1/2 flex -translate-x-1/2 flex-col items-center gap-4">
<!-- Static preview at fixed position inside the canvas -->
<div class="relative h-20 w-12">
<PlantyAvatar x={0} y={0} mood={previewMood} />
</div>
<div class="flex gap-2">
{#each moods as m}
<button
class="rounded-lg border px-3 py-1 text-xs transition"
onclick={() => (previewMood = m)}
style="border-color: {previewMood === m ? 'var(--color-selected)' : 'var(--color-outline)'}; color: {previewMood === m ? 'var(--color-selected)' : 'var(--color-text)'}; background: {previewMood === m ? 'var(--color-layer-2)' : 'transparent'};"
>
{m}
</button>
{/each}
</div>
</div>
</div>
<!-- Sidebar -->
<aside
id="sidebar"
class="flex flex-col gap-3 p-5"
style="border-color: var(--color-outline); background-color: var(--color-layer-0);"
>
<span
class="text-xs font-semibold uppercase tracking-widest"
style="color: var(--color-outline);"
>Parameters</span>
<div
class="rounded-lg px-3 py-2 text-sm"
style="background: var(--color-layer-1); color: var(--color-text);"
>
Branch length: 1.0
</div>
<div
class="rounded-lg px-3 py-2 text-sm"
style="background: var(--color-layer-1); color: var(--color-text);"
>
Segments: 8
</div>
<div
class="rounded-lg px-3 py-2 text-sm"
style="background: var(--color-layer-1); color: var(--color-text);"
>
Leaf density: 0.6
</div>
<span
class="mt-2 text-xs font-semibold uppercase tracking-widest"
style="color: var(--color-outline);"
>Export</span>
<div
class="rounded-lg px-3 py-2 text-sm"
style="background: var(--color-layer-1); color: var(--color-text);"
>
.obj / .glb
</div>
</aside>
</main>
</div>
{#if plantyConfig}
<Planty
bind:this={planty}
config={plantyConfig}
onComplete={() => {
started = false;
}}
/>
{/if}
@@ -0,0 +1,28 @@
<script lang="ts">
import { InputSelect } from '@nodarium/ui';
const themes = [
'dark',
'light',
'solarized',
'catppuccin',
'high-contrast',
'high-contrast-light',
'nord',
'dracula',
'custom'
];
let { theme = $bindable() } = $props();
let themeIndex = $state(0);
$effect(() => {
theme = themes[themeIndex];
const classList = document.documentElement.classList;
for (const c of classList) {
if (c.startsWith('theme-')) document.documentElement.classList.remove(c);
}
document.documentElement.classList.add(`theme-${themes[themeIndex]}`);
});
</script>
<InputSelect bind:value={themeIndex} options={themes}></InputSelect>
+7
View File
@@ -0,0 +1,7 @@
@import "tailwindcss";
body {
color: var(--color-text);
background-color: var(--color-layer-0);
margin: 0;
}
+95
View File
@@ -0,0 +1,95 @@
{
"id": "demo-tutorial",
"avatar": {
"name": "Planty",
"defaultPosition": "bottom-right"
},
"start": "welcome",
"nodes": {
"welcome": {
"type": "choice",
"position": "bottom-right",
"text": "👋 Hey! I'm Planty — your guide to this app. How would you like me to explain things?",
"choices": [
{ "label": "🤓 Technical — give me the details", "next": "intro_nerd" },
{ "label": "🌱 Simple — keep it friendly", "next": "intro_simple" },
{ "label": "No thanks, skip the tour", "next": null }
]
},
"intro_nerd": {
"type": "step",
"position": "bottom-right",
"text": "This is a WebAssembly-powered node graph. Each node is a compiled .wasm module executed in a sandboxed runtime.",
"waitFor": "click",
"next": "highlight_graph_nerd"
},
"intro_simple": {
"type": "step",
"position": "bottom-right",
"text": "Think of this like a recipe card — each block does one thing, and you connect them to build a plant!",
"waitFor": "click",
"next": "highlight_graph_simple"
},
"highlight_graph_nerd": {
"type": "step",
"position": "bottom-left",
"highlight": { "selector": "#graph-canvas", "padding": 12 },
"text": "The graph canvas renders edges as Bézier curves. Node execution is topologically sorted before each WASM call.",
"waitFor": "click",
"next": "highlight_sidebar_nerd"
},
"highlight_graph_simple": {
"type": "step",
"position": "bottom-left",
"highlight": { "selector": "#graph-canvas", "padding": 12 },
"text": "This is the main canvas — drag nodes around and connect them to create your plant!",
"waitFor": "click",
"next": "highlight_sidebar_simple"
},
"highlight_sidebar_nerd": {
"type": "step",
"position": "bottom-right",
"highlight": { "selector": "#sidebar", "padding": 8 },
"text": "The sidebar exposes node parameters, export settings, and the raw graph JSON for debugging.",
"waitFor": "click",
"next": "tip_nerd"
},
"highlight_sidebar_simple": {
"type": "step",
"position": "bottom-right",
"highlight": { "selector": "#sidebar", "padding": 8 },
"text": "The sidebar lets you tweak settings and export your creation.",
"waitFor": "click",
"next": "tip_simple"
},
"tip_nerd": {
"type": "step",
"position": "center",
"text": "Press Space or double-click the canvas to open node search. Nodes are fetched from the WASM registry at runtime.",
"waitFor": "click",
"next": "done_nerd"
},
"tip_simple": {
"type": "step",
"position": "center",
"text": "Press Space anywhere on the canvas to add a new block — try it!",
"waitFor": "click",
"next": "done_simple"
},
"done_nerd": {
"type": "end",
"position": "bottom-right",
"text": "You're all set. Check the docs for the full NodeDefinition interface. Happy hacking! 🌿"
},
"done_simple": {
"type": "end",
"position": "bottom-right",
"text": "That's the tour! Have fun building your plant. 🌱"
}
}
}
+1
View File
@@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" width="107" height="128" viewBox="0 0 107 128"><title>svelte-logo</title><path d="M94.157 22.819c-10.4-14.885-30.94-19.297-45.792-9.835L22.282 29.608A29.92 29.92 0 0 0 8.764 49.65a31.5 31.5 0 0 0 3.108 20.231 30 30 0 0 0-4.477 11.183 31.9 31.9 0 0 0 5.448 24.116c10.402 14.887 30.942 19.297 45.791 9.835l26.083-16.624A29.92 29.92 0 0 0 98.235 78.35a31.53 31.53 0 0 0-3.105-20.232 30 30 0 0 0 4.474-11.182 31.88 31.88 0 0 0-5.447-24.116" style="fill:#ff3e00"/><path d="M45.817 106.582a20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.503 18 18 0 0 1 .624-2.435l.49-1.498 1.337.981a33.6 33.6 0 0 0 10.203 5.098l.97.294-.09.968a5.85 5.85 0 0 0 1.052 3.878 6.24 6.24 0 0 0 6.695 2.485 5.8 5.8 0 0 0 1.603-.704L69.27 76.28a5.43 5.43 0 0 0 2.45-3.631 5.8 5.8 0 0 0-.987-4.371 6.24 6.24 0 0 0-6.698-2.487 5.7 5.7 0 0 0-1.6.704l-9.953 6.345a19 19 0 0 1-5.296 2.326 20.72 20.72 0 0 1-22.237-8.243 19.17 19.17 0 0 1-3.277-14.502 17.99 17.99 0 0 1 8.13-12.052l26.081-16.623a19 19 0 0 1 5.3-2.329 20.72 20.72 0 0 1 22.237 8.243 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-.624 2.435l-.49 1.498-1.337-.98a33.6 33.6 0 0 0-10.203-5.1l-.97-.294.09-.968a5.86 5.86 0 0 0-1.052-3.878 6.24 6.24 0 0 0-6.696-2.485 5.8 5.8 0 0 0-1.602.704L37.73 51.72a5.42 5.42 0 0 0-2.449 3.63 5.79 5.79 0 0 0 .986 4.372 6.24 6.24 0 0 0 6.698 2.486 5.8 5.8 0 0 0 1.602-.704l9.952-6.342a19 19 0 0 1 5.295-2.328 20.72 20.72 0 0 1 22.237 8.242 19.17 19.17 0 0 1 3.277 14.503 18 18 0 0 1-8.13 12.053l-26.081 16.622a19 19 0 0 1-5.3 2.328" style="fill:#fff"/></svg>

After

Width:  |  Height:  |  Size: 1.5 KiB

+17
View File
@@ -0,0 +1,17 @@
import adapter from '@sveltejs/adapter-auto';
/** @type {import('@sveltejs/kit').Config} */
const config = {
compilerOptions: {
// Force runes mode for the project, except for libraries. Can be removed in svelte 6.
runes: ({ filename }) => (filename.split(/[/\\]/).includes('node_modules') ? undefined : true)
},
kit: {
// adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
// If your environment is not supported, or you settled on a specific environment, switch out the adapter.
// See https://svelte.dev/docs/kit/adapters for more information about adapters.
adapter: adapter()
}
};
export default config;
+15
View File
@@ -0,0 +1,15 @@
{
"extends": "./.svelte-kit/tsconfig.json",
"compilerOptions": {
"rewriteRelativeImportExtensions": true,
"allowJs": true,
"checkJs": true,
"forceConsistentCasingInFileNames": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"sourceMap": true,
"strict": true,
"module": "NodeNext",
"moduleResolution": "NodeNext"
}
}
+5
View File
@@ -0,0 +1,5 @@
import tailwindcss from '@tailwindcss/vite';
import { sveltekit } from '@sveltejs/kit/vite';
import { defineConfig } from 'vite';
export default defineConfig({ plugins: [tailwindcss(), sveltekit()] });
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@nodarium/types",
"version": "0.0.4",
"version": "0.0.5",
"description": "",
"main": "src/index.ts",
"scripts": {
+2 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@nodarium/ui",
"version": "0.0.4",
"version": "0.0.5",
"scripts": {
"dev": "vite",
"build": "vite build && npm run package",
@@ -64,6 +64,7 @@
"types": "./dist/index.d.ts",
"type": "module",
"dependencies": {
"@nodarium/ui": "workspace:*",
"@iconify-json/tabler": "^1.2.26",
"@iconify/tailwind4": "^1.2.1",
"@tailwindcss/vite": "^4.1.18",
+3 -2
View File
@@ -1,8 +1,9 @@
{
"name": "@nodarium/utils",
"version": "0.0.4",
"version": "0.0.5",
"description": "",
"main": "src/index.ts",
"main": "./src/index.ts",
"type": "module",
"scripts": {
"test": "vitest",
"format": "dprint fmt -c '../../.dprint.jsonc' .",
+1484 -411
View File
File diff suppressed because it is too large Load Diff
+3
View File
@@ -7,3 +7,6 @@ packages:
catalog:
chokidar-cli: github:open-cli-tools/chokidar-cli#semver:v4.0.0
onlyBuiltDependencies:
- "@tailwindcss/oxide"
- esbuild