Files
talemate/docs/user-guide/node-editor/reference/nodes/util-packaging.md
veguAI 89e01ac138 Node editor node reference glossary (#107) (#111)
* docs: complete node editor node reference glossary (#107) - generated by new nodes.tools glossary subcommand, 47 categorized pages covering all 403 nodes, docstring gap fixes, help-agent docs-index entries

* docs: fix Jinja2 Format discoverability - document dynamic-input template variables, move node to string page, link key inference from dynamic-input notes, strip links from index summaries

* help agent: keep node reference out of the chat prompt - collapse glossary entries to one pointer line (~19k chars saved), agent retrieves node info via search_docs/read_doc tool calls

* help agent: replace in-prompt docs index with find_docs lookup tool - prompt carries a 13-line section overview (~1.5k chars vs ~66k), pages located via keyword-scored find_docs at runtime

* changelog: help agent prompt slimming + find_docs lookup

* docs: sort node reference index and nav alphabetically by page title

* review: move module constants into top-of-file constant blocks (glossary MAX_DEFAULT_LENGTH; docs SECTION_DESCRIPTIONS, _FIND_STOPWORDS, FIND_DOCS_LIMIT)

* review: word-boundary find_docs scoring with plural/-ing folds, find_docs+section_overview unit tests, jinja2 template field description override

* docs: help agent overview no longer claims an in-prompt index of all documentation pages

* docs: full node docstring audit pass - 335 classes audited by 5 agents, ~89 accuracy fixes (nonexistent/misnamed sockets, wrong behavior claims), ~94 expansions, 5 factually-wrong PropertyField descriptions corrected, glossary regenerated
2026-07-20 01:49:33 +03:00

3.3 KiB

Packaging Nodes

Package node modules for reuse and installation into scenes — see Package for the packaging workflow.

4 nodes.

Node Registry path
Dynamic Storyline Package package/talemate/DynamicStoryline
Install Node Module util/packaging/InstallNodeModule
Package util/packaging/Package
Promote Config util/packaging/PromoteConfig

Dynamic Storyline Package

package/talemate/DynamicStoryline

Node module (base type util/packaging/Package) defined in src/talemate/game/engine/nodes/modules/scene/dynamic-storyline-package.json.

Properties

Property Type Default Description
package_name str "Dynamic Storyline" The name of the node module
author str "Talemate" The author of the node module
description str "Generate a random story premise at the beginning of the scene." The description of the node module
installable bool True Whether the node module is installable to the scene
restart_scene_loop bool True Whether the scene loop should be restarted after the package is installed

Install Node Module

util/packaging/InstallNodeModule

Marks a node module for installation when placed inside a Package graph.

When the package is installed to a scene, each InstallNodeModule node causes the referenced node module to be instantiated and added to the scene loop.

Properties

Property Type Default Description
node_registry str unset The registry path of the node module to package

Package

util/packaging/Package

Graph that defines an installable package of node modules for easy scene installation.

Place InstallNodeModule nodes inside it to mark node modules for installation, and PromoteConfig nodes to expose module properties as package configuration.

Properties

Property Type Default Description
package_name str "" The name of the node module
author str "" The author of the node module
description str "" The description of the node module
installable bool True Whether the node module is installable to the scene
restart_scene_loop bool False Whether the scene loop should be restarted after the package is installed

Promote Config

util/packaging/PromoteConfig

Promotes a single module property to be configurable through the scene once the package is installed.

Place inside a Package graph alongside the InstallNodeModule node whose module property should be exposed.

Properties

Property Type Default Description
node_registry str unset The registry path of the node module to package
property_name str unset Property Name
exposed_property_name str unset Exposed Property Name
required bool False Whether the property is required
label str "" Label