-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcontribute.html
25 lines (19 loc) · 1.68 KB
/
contribute.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<p><b>This project stands or falls on your contribution.</b></p>
<p>Besides lots of todos regarding the core system, hundreds of nodes want to be ported. Some of them being complex, but also many simple ones, which can be implemented quicker than you can say some
phrase of medium length.</p>
<p>It's very easy to write your own nodes. Basically the only thing you need is a text editor. However, the best way to get your nodes into the VVVV.js repository on GitHub is to follow these steps:</p>
<ol>
<li><a href="https://github.com/zauner/vvvv.js/fork">Fork</a> the project's <a href="https://github.com/zauner/vvvv.js">Git Repository on GitHub</a></li>
<li>Use the <a href="http://vvvvjs.quasipartikel.at/porting_wizard">Node Porting Wizard</a> to create some template code to start with.</li>
<li>There's one .js file for each node category in the 'node' directory. Add your code to the corresponding file, or create a new one, if you start a new category.</li>
<li>Adjust the meta data</li>
<li>Create a dummy module and add it to the vvvv_js_modules directory, if necessary (see below)</li>
<li>Commit your changes to your fork, and make a new issue at the GitHub page, to announce your node</li>
</ol>
<h2>Further Documentation</h2>
There are several guides and documents on <a href="http://substance.io">Substance.io</a> that help you coding your own nodes:
<ul>
<li><a href="http://substance.io/zauner/porting-vvvv-nodes-to-vvvvjs">Porting VVVV Nodes to VVVV.js</a></li>
<li><a href="http://substance.io/zauner/porting-vvvv-hlsl-shaders-to-vvvvjs">Porting VVVV HLSL shaders to VVVV.js</a></li>
<li><a href="http://substance.io/zauner/vvvvjs-api-reference">VVVV.js API reference</a></li>
</ul>