Vibrante-Node Documentation

Full reference for v2.0.0 โ€” 14 chapters covering installation, node development, Houdini integration, and the full Python API.

All Documentation Sections

๐Ÿ“–

Introduction

What Vibrante-Node is, what problems it solves, and how the node + exec-pin model works.

๐Ÿš€

Getting Started

Installation from source, first launch, configuring Houdini integration, and running your first workflow.

๐ŸŽฎ

User Guide

Full guide to the Vibrante-Node UI: canvas, library, log panel, mini-map, canvas search, and keyboard shortcuts.

๐ŸŽฌ

Workflow Tutorials

Step-by-step tutorials for building real pipelines: Houdini, Maya, Prism, and AI orchestration workflows.

๐Ÿ”ง

Node Development

How to create custom nodes: BaseNode API, JSON format, exec pins, port types, and the Node Builder GUI.

โš™๏ธ

Backend Architecture

How the async execution engine works: DAG resolution, signal flow, asyncio integration, and error handling.

๐ŸŽจ

Frontend Architecture

The PyQt5 UI: scene graph, NodeWidget, Edge/wire rendering, live wire inspector, mini-map, and theming.

๐Ÿ“š

API Reference

Complete API for BaseNode, HouBridge, PrismCore resolver, WorkflowModel, and all built-in utility functions.

๐Ÿ”ฌ

Advanced Topics

GroupNode subgraphs, autosave/crash recovery, headless execution, workflow serialization, and the Houdini plugin architecture.

๐Ÿค

Contribution Guide

How to contribute: code style, testing, PR process, and adding new node categories or integrations.

๐Ÿ”

Troubleshooting

Common issues: Houdini connection failures, port bind errors, QScintilla missing, PyQt5 conflicts, and crash recovery.

๐Ÿ“

Examples Library

Ready-to-use .vnw workflow files and custom node examples covering all integration categories.

๐Ÿค–

General-Purpose Automation

Using Vibrante-Node outside of DCC tools: file operations, HTTP APIs, JSON processing, and Python scripting nodes.

๐Ÿงฉ

Custom Nodes API

The complete custom node API: all add_input() / add_output() options, log_error(), set_output(), parameters dict, and the Node Builder.