sn-vi-visual-script
v1.0.6
Published
Node-based visual programming framework
Downloads
497
Maintainers
Readme
Node Framework
A TypeScript-based visual scripting framework built on top of Litegraph.js
Installation
npm install @your-scope/node-framework
Usage
Basic Example
import { NodeManager, NodeRegistry, BaseNode } from '@your-scope/node-framework';
// Initialize the framework
const nodeManager = NodeManager.getInstance();
await nodeManager.loadNodeConfig();
// Create a custom node
@Node({
name: "MyCustomNode",
category: "Custom",
description: "My custom node"
})
class MyCustomNode extends BaseNode {
constructor() {
super();
this.addInput("input", "number");
this.addOutput("output", "number");
}
onExecute() {
const value = this.getInputData(0);
this.setOutputData(0, value * 2);
}
}
// Register your custom node
const registry = NodeRegistry.getInstance();
registry.register(MyCustomNode);
Advanced Usage
For more advanced usage and examples, please check our documentation.
Features
- TypeScript-based node framework
- Built on top of Litegraph.js
- Decorators for easy node creation
- Support for custom node types
- Built-in device support (Hand, Body, Facial tracking)
- Extensible architecture
Development
# Install dependencies
npm install
# Start development server
npm run start
# Build the library
npm run build:lib
# Run tests
npm test
Documentation
Generate and view the documentation:
npm run docs
Contributing
Contributions are welcome! Please read our Contributing Guide for details.
License
This project is licensed under the MIT License - see the LICENSE file for details.