{"id":49677615,"url":"https://github.com/dotsimulate/tdfam","last_synced_at":"2026-05-10T04:06:51.016Z","repository":{"id":353027251,"uuid":"1107317297","full_name":"dotsimulate/TDFam","owner":"dotsimulate","description":"TouchDesigner custom operator families — TAB menu integration, manifests, placement, stubs, and updates in one .tox component.","archived":false,"fork":false,"pushed_at":"2026-05-05T00:01:13.000Z","size":70016,"stargazers_count":6,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-05T01:27:28.434Z","etag":null,"topics":["touchdesigner","touchdesigner-tools"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotsimulate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-01T00:56:53.000Z","updated_at":"2026-04-28T15:44:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/dotsimulate/TDFam","commit_stats":null,"previous_names":["dotsimulate/tdfam"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/dotsimulate/TDFam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotsimulate%2FTDFam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotsimulate%2FTDFam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotsimulate%2FTDFam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotsimulate%2FTDFam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotsimulate","download_url":"https://codeload.github.com/dotsimulate/TDFam/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotsimulate%2FTDFam/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32720800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["touchdesigner","touchdesigner-tools"],"created_at":"2026-05-07T03:05:53.734Z","updated_at":"2026-05-07T03:05:57.766Z","avatar_url":"https://github.com/dotsimulate.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TDFam\n\nCreate custom operator families for TouchDesigner. A TDFam family is a named group of custom operators that appear together in TD's OP Create dialog, the menu opened with TAB.\n\nOperators can live inside the TDFam component as COMPs, or outside it as `.tox` files in a folder. TDFam handles the connection between those operator sources, the TouchDesigner UI, and the lifecycle of placed operators.\n\n## Contributors\n\n- [Lyell Hintz / dotsimulate](https://dotsimulate.com)\n- [Dan Molnar / function.str](https://www.functionstore.xyz/link-in-bio)\n\n## TDFam Component\n\nThe TDFam component (`TDFam_create`) defines one family. It is packaged inside each family by the developer — it stores the family name, color, operator sources, callbacks, and metadata. A family can use embedded operators (COMPs inside `Opcomp`), file-based operators (`.tox` files in `Opfolder`), or both. When both sources provide the same operator, TDFam picks the higher version.\n\nMultiple families are ordered in the OP Create menu by their `Index` parameter, then alphabetically within the same index. Set `Index` to `-1` to pin a family to the end of the list.\n\nDev mode is available on the About page for development and testing. **Turn dev mode off before releasing to users.**\n\nBehind the scenes, a shared **TDFamRegistry** component coordinates all installed families — it handles UI injection into the OP Create menu, operator management, stubs, and updates.\n\n## Operators and Manifests\n\nEach operator can carry a manifest that defines how it appears in the menu and how its data is preserved across stubs and updates.\n\n| Manifest field | What it controls |\n|---|---|\n| `op_type` | Canonical operator identity used for lookup and placement |\n| `op_label` | Display name in the OP Create menu |\n| `op_group` | Menu grouping (e.g. \"Generators\", \"Filters\") |\n| `op_color` | Operator color in the menu and network |\n| `op_version` | Version tracking for updates |\n| `isFilter` | Filter vs generator classification |\n| `compatible_types` | Which TD operator types this can connect to |\n| `summary` | One-line description shown in the menu |\n| `doc_url` | Link to operator documentation |\n| `search_words` | Additional terms for menu search |\n| `pop_menu` | Right-click menu entries and actions |\n\nFile-based operators can use external JSON manifests (sidecar or folder-based). Family-level metadata — summary, documentation, support URL, and pop-menu entries — lives in an optional `family_info` DAT. Config tables provide bulk controls for grouping, label replacement, and OS compatibility.\n\nSee the [Manifest Reference](docs/manifest-reference.md) and [Config Reference](docs/config-reference.md) for the full field list and formats.\n\n## Placement, Stubs, and Updates\n\nWhen a family is installed, its operators appear in TD's OP Create dialog. TDFam handles placement, manifest validation, color, shortcuts, and callbacks. Shortcuts can toggle or pulse a parameter, or dispatch a named callback through the family's callback DAT.\n\nPlaced operators can be converted to **stubs** — lightweight placeholders that preserve the network shape, wiring, and retained data without carrying the full implementation. This lets project files be shared between users without distributing private or paid `.tox` components. Replacing a stub loads the full operator back from the installed family.\n\n**Updates** load a newer version of an operator while preserving retained parameters and state, so users don't lose their work when a family ships a new release.\n\nSee [Concepts](docs/concepts.md) and [Callbacks \u0026 API](docs/callbacks-and-api.md) for the full lifecycle and available hooks.\n\n## Quickest Start\n\n1. Add the TDFam `.tox` to your project.\n2. Set the family name, color, and version.\n3. Point `Opcomp` or `Opfolder` at your operators.\n4. Toggle `Install`.\n\nYour operators are now in the TAB menu. For callbacks, manifests, stubs, and config — see [Concepts](docs/concepts.md).\n\n\u003e **Developer note:** Keep the `Version` parameter (Family tab) updated with each release. TDFam inherits it into operator manifests as `fam_version` and as a fallback `op_version` for operators that don't define their own. When packaging your family component for distribution, consider promoting `Version` to the top level so users can see it without diving into the component.\n\n## Updates\n\nTDFam checks for registry updates automatically. Users can see available updates in the FAM UI button (top right), on the About page — the indicator turns yellow when an update is ready.\n\nFamily developers should keep the TDFamRegistry bundled inside their TDFam component up to date. If a user has a newer registry version on disk, TDFam will load that instead of an outdated bundled one.\n\n## Documentation\n\n- [Concepts](docs/concepts.md): architecture, sources, tags, stubs, config sync, and lifecycle.\n- [Manifest Reference](docs/manifest-reference.md): OpInfo, ParRetain, StateRetain, Shortcuts, pop menus, and external manifests.\n- [Callbacks \u0026 API](docs/callbacks-and-api.md): methods, callbacks, and lifecycle hooks.\n- [Config Reference](docs/config-reference.md): config tables, family parameters, and JSON import/export.\n- [Licensing and Attribution](docs/licensing.md): Apache-2.0 terms, NOTICE handling, and attribution.\n\n## Requirements\n\n- TouchDesigner 2023+\n\n## License\n\nTDFam is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).\n\nIf you distribute TDFam, a modified version of TDFam, or a TouchDesigner\ncomponent or operator family that includes TDFam, preserve the Apache-2.0\nlicense notices and the [NOTICE](NOTICE) attribution file as required by the\nlicense.\n\nOperator families, `.tox` files, manifests, callbacks, artwork, and\nproject-specific logic created with TDFam may use their own licenses.\n\nSuggested attribution:\n\n\u003e Built with TDFam, an open-source TouchDesigner operator-family framework\n\u003e created by [Lyell Hintz / dotsimulate](https://dotsimulate.com) and\n\u003e [Dan Molnar / function.str](https://www.functionstore.xyz/link-in-bio).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotsimulate%2Ftdfam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotsimulate%2Ftdfam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotsimulate%2Ftdfam/lists"}