From ba6f9a523ddf09408a2713184fefa4983b1eb0c9 Mon Sep 17 00:00:00 2001 From: Kristofer Date: Sat, 2 Dec 2017 10:33:58 +0100 Subject: [PATCH] Added lightweight npm publish --- build/README.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++ build/package.json | 23 +++++++++++++ package.json | 2 +- 3 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 build/README.md create mode 100644 build/package.json diff --git a/build/README.md b/build/README.md new file mode 100644 index 0000000000..bd9846994f --- /dev/null +++ b/build/README.md @@ -0,0 +1,80 @@ +# litegraph.js + +A library in Javascript to create graphs in the browser similar to [PureData](https://puredata.info/). Nodes can be programmed easily and it includes an editor to construct the graphs. + +It can be integrated easily in any existing web applications and graphs can be run without the need of the editor. + +## Creating a Graph ## + +You can create graphs from the editor (and store them in JSON) or directly from code: + +```javascript + +var graph = new LGraph(); +var node = LiteGraph.createNode("basic/const"); +var node2 = LiteGraph.createNode("basic/watch"); +graph.add( node ); +graph.add( node2 ); +node.connect(0, node2, 0); //connect node slot 0 to node2 slot 0 + +graph.runStep(1); //execute one cycle +``` + +## How to code a new Node type + +Here is an example of how to build a node that sums two inputs: + +```javascript +//node constructor class +function MyAddNode() +{ + this.addInput("A","number"); + this.addInput("B","number"); + this.addOutput("A+B","number"); +} + +//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 ); + +``` + + +## Projects using it + +### [webglstudio.org](http://webglstudio.org) + +![WebGLStudio](imgs/webglstudio.gif "WebGLStudio") + +### [MOI Elephant](http://moiscript.weebly.com/elephant-systegraveme-nodal.html) + +![MOI Elephant](imgs/elephant.gif "MOI Elephant") + +### [Mynodes.NET](http://www.mynodes.net) + +![MyNodes.NET](imgs/mynodes.png "MyNodes.NET") + +## Utils +----- + +It includes several commands in the utils folder to generate doc, check errors and build minifyed version. + + +## Feedback +-------- + +You can write any feedback to javi.agenjo@gmail.com diff --git a/build/package.json b/build/package.json new file mode 100644 index 0000000000..1227cbf451 --- /dev/null +++ b/build/package.json @@ -0,0 +1,23 @@ +{ + "name": "litegraph.js", + "version": "0.1.1", + "description": "A graph node editor similar to PD or UDK Blueprints, it works in a HTML5 Canvas and allow to exported graphs to be included in applications.", + "main": "litegraph.js", + "directories": { + "doc": "doc" + }, + "private": false, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/jagenjo/litegraph.js.git" + }, + "author": "jagenjo", + "license": "MIT", + "bugs": { + "url": "https://github.com/jagenjo/litegraph.js/issues" + }, + "homepage": "https://github.com/kriffe/litegraph.js#readme" +} diff --git a/package.json b/package.json index 59ead438c1..b7ca74892a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@skymaker/litegraph.js", - "version": "0.1.0", + "version": "0.1.1", "description": "A graph node editor similar to PD or UDK Blueprints, it works in a HTML5 Canvas and allow to exported graphs to be included in applications.", "main": "build/litegraph.js", "directories": {