» Conventions.HelpPatch
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

Conventions.HelpPatch

Italian | Spanish

A HelpPatch demonstrates the functionality of a node. Ideally a novice should quickly get an idea of what the node is about and an expert should get detailed information on its usage.

Design Tips

  • create a helppatch for a node by selecting it and pressing F1. if the node does not have a helppatch yet, a dummy patch with already the right name will open. simply press CTRL+S to save the patch to disk and then start modifying it.
  • first find the most simple usage scenario of a node which will give the novice a quick overview
  • now explain the node a second time with a more advanced usage scenario and put that graph right next to the simple scenario
  • find further scenarios if applicable and place them right next to the existing
  • create IOBoxes for input pins that you set to values other than their default
  • don't label them (as if they were inputs) but write a comment next to them and explain their usage
  • in all your texts/comments please stick to the naming conventions.
  • create a see also section where you place related nodes that the user is supposed to also checkout.
  • add links to online information (wikipedia,..) regarding the functionality of the node

Contribute

If you want your helppatch included with the next release please add them to this forum thread: missing-helppatches

anonymous user login

Shoutbox

~17h ago

~2d ago

joreg: Everyone go checkout this growing list of #vvvv beta tutorials by Takuma Nakata: https://www.youtube.com/playlist?list=PLK3HDkvkLePS9UKCVw1o_eb09Ocws6Wcr Thanks for those!

~2d ago

evvvvil: "Energy Confinement": Result of Tuesday's improvised live coding session on Twitch. https://www.shadertoy.com/view/WslyDl

~3d ago

m9dfukc: @siyah Yes! macOs support ... more like a distant dream but hey ;)

~3d ago

siyah: such a great news @devvvvs ps.I'm dreaming osx version (:

~3d ago

dottore: Congratulations @devvvvs!!!! :)

~5d ago

ggml: what a treat it is to sample the microdevil_intersect help patch from time to time