FNSTools by Function Store

Docs Developer

ConfigHost

A standalone ConfigRegistry host. Drop it into a component to give it roaming settings; its parameters save and reload with your config, with per-parameter and per-page exclusions.

⌨ Developer

Config Host

Every FNS tool that remembers its settings does so by carrying a small ConfigRegistry host. This is that host on its own, so a component outside the toolkit can have the same thing: its parameters are written into the shared settings file and restored on load.

It needs ConfigRegistry present; the host publishes into that registry, which owns the file. Without it the host simply stays idle.

Adopting it

Drag the COMP inside the component whose settings should roam, then set its Registration page:

Par Meaning
Comp the component whose parameters are saved; defaults to ..
Canonicalname the section name in the settings file; empty = the component's name
Autoregister publish while the component exists
Autoload restore saved values when it registers
Persistpars save the component's custom parameters
Excludepars / Excludepages leave named parameters or whole pages out
Callback / Createcallbacks optional DAT for save/load hooks; the pulse writes a starter

Promotepars mirrors the key parameters onto the parent as a bound Registry page, so it can be configured without opening the host.

The one thing to get right

Canonicalname is the key your settings are stored under. Renaming it orphans everything saved under the old name; the values remain in the file, but the component stops seeing them. Choose it once.

ConfigRegistry's scope decides whether settings roam across all your projects or stay with one.

Get it

Tick it on the install page and it installs with the rest of your setup and stays up to date.

Download FNS_ConfigHost.tox Version 3.2.6, the tool on its own. It works in any project, and this copy never updates itself.

Parameters

Registration

ControlType / defaultWhat it does
Tool COMPComp operator.. Tool COMP whose settings are persisted. Defaults to the parent component (the host lives inside the tool it publishes).
Canonical NameCanonicalname textempty Unique name for this tool's section in the config file.
Callback DATCallback operatorempty Optional config_callbacks DAT for state beyond parameters (onConfigSave/onConfigLoad).
Create CallbacksCreatecallbacks button Spawn a 'config_callbacks' DAT into this tool from the registry's template and wire this host's Callback parameter to it. Safe to pulse again: an existing DAT is adopted, never overwritten.
Auto-registerAutoregister on / offoff When on, keep this tool published into the global config registry while this component exists.
RegisterRegister button Publish once into the global config registry, even if Auto-register is off.
UnregisterUnregister button Take this tool's contribution back out of the registry and turn Autoregister off, so it stays out. Register puts it back.
Registration StatusRegstatusread-only textempty Read-only status of this host registration.
Auto-loadAutoload on / offon Apply this tool's saved section from the config file once per session, shortly after the tool registers. Turn off for a tool whose settings should stay project-local.
Persist ParametersPersistpars on / offon Snapshot and restore the tool COMP's custom parameters (value, expression, bind + mode). Meta pages (About, Version Ctrl, Info, Callbacks, Common) are always skipped; missing parameters are never created on load.
Exclude ParsExcludepars textempty Space-separated name patterns (tdu.match) of custom parameters to leave out of persistence, e.g. 'Spoutactive Ndi*'. Use for parameters that must boot at their defaults.
Exclude PagesExcludepages textempty Space-separated page-name patterns to leave out of persistence entirely.
Help URLHelpurl textempty The tool's wiki/help page. Informational for config; leave empty to skip.
Promote ParametersPromotepars on / offon When on, the host mirrors its key Registration parameters onto the parent tool as a bound 'Registry' page. Turn off before shipping a tool that should not expose registry controls.

Config

ControlType / defaultWhat it does
Config ScopeConfigscope menuGlobal (user palette, roams) Follows the toolkit root's Config Scope (op.FNS, FNSTools page) through a guarded expression, and reads 'project' when there is no root: a standalone tool release keeps its settings in the .toe. Author on the root; the root par is the record.
Options: Global (user palette, roams), Project (.toe only)
Config FileConfigfile file pathempty Override the config file location. Empty = the user palette default (FNSTools/config/FNStools_config.json). Evaluated by the /sys global; set it on the FNS_Config master so promotion carries it.
Save All NowSaveall button Snapshot every registered tool into the config file now (forwards to the global).
Load All NowLoadall button Re-apply every registered tool's saved section now (forwards to the global).

Edit this page on GitHub →