Auragen docs
Auragen docs

Getting Started

OverviewInterfaceNode GraphParameters and Controls

Operators

3D Preview

Node Graph

How to add, wire, preview, and organise operators in the graph.

The node graph is where you build a patch. Operators are nodes, wires carry data between them, and the Output node is what the viewport and every output stream show.

A node graph

  • Press Tab to add an operator at the cursor
  • Drag from an output port to an input port to wire two nodes
  • Press P on a node to preview it
  • Press Z to frame every node at the current level

Adding operators

The operator search overlay

Press Tab over the canvas to open the search overlay at the cursor. With the field empty it browses: one tab per family — Generators, Texture, Post FX, Particles, Surfaces, Cloners, SDF, Modifiers, I/O. Type to filter across all of them.

In the overlay:

  • ↓ / ↑ — move the selection
  • Enter — place the operator and close
  • Tab — place it, wire it to the operator you just placed, and reopen to the right
  • Shift+Tab — place it below, unwired, and reopen
  • Escape — close

Repeated Tab is how you build a chain quickly: each pick lands wired to the previous one.

The overlay also opens when you double-click empty canvas, right-click empty canvas, or drop a wire on empty canvas. Dropped from a wire, it lists only operators that can accept that connection.

You can also drag an operator from the Operators palette onto the canvas, or double-click it in the palette.

Wiring

Drag from a port to make a wire. Pressing a connected input and dragging picks the existing wire up and re-routes it; a plain click still just selects.

  • Delete a wire — hold Ctrl and click it, or hold T and drag a cut line across several wires
  • N — disconnect every wire on the selection
  • Insert into a wire — hover a wire and click the bubble that appears, then pick an operator. Dragging a node onto a wire splices it in the same way
  • O — wire the selected node straight to the Output node

Ports are typed and colour-coded, and a port only accepts a matching type. Texture ports carry images, Surface ports carry 3D geometry, and Modifier ports carry the values that drive parameters. Particle and cloner operators have their own emitter, effector, and renderer port types.

Previewing

The viewport shows the Output node by default. Press P on a selected node to cycle its preview state: off → viewport → inline on the node card → off. Several previewed nodes tile inside the viewport panel.

The eye button on each row of the Hierarchy panel does the same thing.

Base nodes preview like any other operator. Inline previews are on by default; turn previews off and the Base card holds a still of the last frame it drew, so you can see what is inside without paying to render it. On a large graph, turning previews off is the quickest way to get the canvas responsive again.

The Output node is what NDI, Spout, exports, and Perform mode all read. A node with a preview on is only being watched, not sent.

Moving around

  • Pan — middle-drag, or hold Space and left-drag
  • Zoom — scroll wheel, centred on the cursor
  • Z — frame every node at the current level
  • Keep scrolling past full zoom over a Base node to drop inside it; keep scrolling out to leave

The zoom percentage sits at the top left of the canvas.

Selecting and editing

  • Left-click selects; Shift+click adds to the selection; left-drag on empty canvas draws a marquee
  • ⌘A selects everything at the current level, ⌘⇧A deselects
  • ⌘C / ⌘V copy and paste — paste lands at the mouse
  • ⌘D duplicates, and Alt+drag duplicates a node and drags the copies
  • Delete removes the selection
  • ⌘Z / ⌘Y undo and redo

Right-click a node for Rename / recolor (F5), Replace operator with…, Copy, Duplicate, Disconnect, Collapse to Base, and Delete.

Organising a graph

Bases are subnetworks. Select some nodes and choose Collapse to Base to fold them into one node. Press i to go inside a Base, U to come back out, and use the breadcrumb bar to jump between levels. A Base can be saved to the Snippets panel and dragged into another patch.

Regions and comments annotate the graph. Press R to draw a region around the selection and C to drop a comment. Dragging a region moves every node inside it. Selecting either one shows its own controls in the parameter panel.

On a selection that contains 3D operators — Surfaces, Particles, or Cloners — plain R is the gizmo's Rotate key. Use Shift+R to make a region instead.

Troubleshooting

Nothing renders — check that something is wired into the Output node. The viewport hint reads Add Output node · P to preview when there is nothing to show.

Tab types into a field instead of opening search — the overlay is suppressed while a text field has focus, and while the pointer is over the parameter panel, where Tab steps between value fields. Move the cursor over the canvas first.

A node outputs nothing — check the port types match. A Float output wired into a Texture input will not carry an image.

Related

Interface

The panels around the graph.

Parameters and Controls

Driving parameters once nodes are wired.

Generators

Every generator operator.

Interface

The panels, menus, and transport controls of the Auragen workspace.

Parameters and Controls

How every operator's parameters are laid out, and the four ways to drive them.

On this page

Adding operatorsWiringPreviewingMoving aroundSelecting and editingOrganising a graphTroubleshootingRelated