Loading Patchies...

Help

In-app help panel

The Help panel in the sidebar provides quick reference for any object in your patch.

Opening Help

  • Click the ? button in the sidebar, or use Ctrl/Cmd + B > Help
  • Select any object in your patch to see its documentation
  • Or use the Object Browser's help (?) button to browse all objects

What's Shown

  • Description - What the object does
  • Inlets - Input ports and what messages they accept
  • Outlets - Output ports and what they send
  • Usage notes - Tips and examples

Help Patches

Some objects have interactive help patches that demonstrate usage. Click Open Help Patch to load an example you can play with.

Object Browser Help

Object browser help modal

Enable the ? help toggle to browse object documentation in the sidebar instead of inserting.

Guides

The guides menu at the top of the help panel lets you browse guides without leaving the app - the same documentation you're reading now.

See Also