litegraph.tsx

A number of people have attempted to update litegraph to have some modern features over the years including myself. Recently there's been renewed interest, and we wanted to establish a new project and group for it so that it's cooperative.

This repo has been created to modernize the popular flow graph library Litegraph so that it meets modern coding and tooling standards. At a later date we may start adding features.

litegraph.js

A library in Javascript to create graphs in the browser similar to Unreal Blueprints. Nodes can be programmed easily and it includes an editor to construct and tests the graphs.

It can be integrated easily in any existing web applications and graphs can be run without the need of the editor.

Try it in the demo site.

Node Graph

Features

Renders on Canvas2D (zoom in/out and panning, easy to render complex interfaces, can be used inside a WebGLTexture)
Easy to use editor (searchbox, keyboard shortcuts, multiple selection, context menu, ...)
Optimized to support hundreds of nodes per graph (on editor but also on execution)
Customizable theme (colors, shapes, background)
Callbacks to personalize every action/drawing/event of nodes
Subgraphs (nodes that contain graphs themselves)
Live mode system (hides the graph but calls nodes to render whatever they want, useful to create UIs)
Graphs can be executed in NodeJS
Highly customizable nodes (color, shape, slots vertical or horizontal, widgets, custom rendering)
Easy to integrate in any JS application (one single file, no dependencies)
Typescript support

Nodes provided

Although it is easy to create new node types, LiteGraph comes with some default nodes that could be useful for many cases:

Interface (Widgets)
Math (trigonometry, math operations)
Audio (AudioAPI and MIDI)
3D Graphics (Postprocessing in WebGL)
Input (read Gamepad)

Installation

You can install it using npm

npm install litegraph.js

Or downloading the build/litegraph.js and css/litegraph.css version from this repository.

First project

<html>
<head>
    <link rel="stylesheet" type="text/css" href="https://github.com/litegraph-tsx/litegraph.tsx/blob/main/litegraph.css">
    <script type="text/javascript" src="https://github.com/litegraph-tsx/litegraph.tsx/raw/main/litegraph.js"></script>
</head>
<body style='width:100%; height:100%'>
<canvas id='mycanvas' width='1024' height='720' style='border: 1px solid'></canvas>
<script>
var graph = new LGraph();

var canvas = new LGraphCanvas("#mycanvas", graph);

var node_const = LiteGraph.createNode("basic/const");
node_const.pos = [200,200];
graph.add(node_const);
node_const.setValue(4.5);

var node_watch = LiteGraph.createNode("basic/watch");
node_watch.pos = [700,200];
graph.add(node_watch);

node_const.connect(0, node_watch, 0 );

graph.start()
</script>
</body>
</html>

How to code a new Node type

Here is an example of how to build a node that sums two inputs:

//node constructor class
function MyAddNode()
{
  this.addInput("A","number");
  this.addInput("B","number");
  this.addOutput("A+B","number");
  this.properties = { precision: 1 };
}

//name to show
MyAddNode.title = "Sum";

//function to call when the node is executed
MyAddNode.prototype.onExecute = function()
{
  var A = this.getInputData(0);
  if( A === undefined )
    A = 0;
  var B = this.getInputData(1);
  if( B === undefined )
    B = 0;
  this.setOutputData( 0, A + B );
}

//register in the system
LiteGraph.registerNodeType("basic/sum", MyAddNode );

or you can wrap an existing function:

function sum(a,b)
{
   return a+b;
}

LiteGraph.wrapFunctionAsNode("math/sum",sum, ["Number","Number"],"Number");

Server side

It also works server-side using NodeJS although some nodes do not work in server (audio, graphics, input, etc).

var LiteGraph = require("./litegraph.js").LiteGraph;

var graph = new LiteGraph.LGraph();

var node_time = LiteGraph.createNode("basic/time");
graph.add(node_time);

var node_console = LiteGraph.createNode("basic/console");
node_console.mode = LiteGraph.ALWAYS;
graph.add(node_console);

node_time.connect( 0, node_console, 1 );

graph.start()

Projects using it

comfyUI

screenshot

webglstudio.org

WebGLStudio

MOI Elephant

Mynodes

MyNodes

Utilities

It includes several utilities available via npm run * which can be found in package.json

Demo

The demo includes some examples of graphs. In order to try them you can visit demo site or install it on your local computer, to do so you need git, node and npm. Given those dependencies are installed, run the following commands to try it out:

$ git clone https://github.com/litegraph-tsx/litegraph.tsx.git
$ cd litegraph.tsx
$ npm i
$ npm run server
Example app listening on port 8000!

Open your browser and point it to http://localhost:8000/. You can select a demo from the dropdown at the top of the page.

Contributors

Daniel
atlasan
DrJKL

(litegraph.js, from which this is forked)

Javi
kriffe
rappestad
InventivetalentDev
NateScarlet
coderofsalvation
ilyabesk
gausszhou

litegraph-tsx / litegraph.tsx

readme