Docs Reference
Common parameters
The controls every package carries, whatever the tool does.
About
Read-only, on every package. Pkgversion is what the updater compares.
| Control | Type / default | What it does |
|---|---|---|
LinkLink |
button | Open this tool's page on the FNS docs site. |
Package VersionPkgversion |
text1.0.1 | The package version the FNS updater compares against the release manifest. |
AuthorAuthor |
textFunction Store @function.str | Who made this tool. |
AuthorAuthornameread-only |
textempty | Who wrote this component. Read-only. |
LinkOpenauthor |
button | Open the author's page in your browser. |
Build NumberBuildread-only |
number0 | Build counter of this component. |
Build DateDateread-only |
textempty | When this build was made. |
Touch BuildTouchbuildread-only |
textempty | TouchDesigner build this component was last saved with. |
VersionVersionread-only |
textempty | FNS_CommandKit version. |
TDFam CreatorsTdfamcreatorsread-only |
sequence0 | Read-only: the people who created the TDFam framework this family is built on. |
NameTdfamcreators0nameread-only |
textempty | Read-only: the name of a TDFam creator. |
NameTdfamcreators1nameread-only |
textempty | Read-only: the name of a TDFam creator. |
Package VersionPackageversionread-only |
textempty | Read-only: the version of the package as shipped. |
Package VariantPkgvariantread-only |
textempty | Which build this copy is (base or pro): set by the release hook per edition; the FNS updater and installer read it beside Pkgversion. |
Last UpdatedLastupdatedread-only |
text2025-03-07 | When the author last changed this component. Read-only, and unrelated to when you installed it. |
CreatorCreatorread-only |
textempty | Who wrote this component. Read-only. |
WebsiteWebsiteread-only |
textempty | The author's site. Read-only. |
.tox Save BuildToxsavebuildread-only |
textempty | The TouchDesigner build this component's .tox was last saved with. An older TouchDesigner loads a newer-build tox as nothing at all, silently, so this is the floor for installing it. |
Registry sections
Registering with a surface adds a section to a tool's Registry page. Each registry documents its own:
- FNS_ConfigRegistry: 9 controls
- FNS_Console: 7 controls
- FNS_HubRegistry: 7 controls
- FNS_NavbarRegistry: 7 controls
- FNS_OpMenuRegistry: 7 controls
- FNS_PaneTypeRegistry: 5 controls
- FNS_ToolbarRegistry: 7 controls