Menu Reference
Access the main menu by clicking the hamburger icon (☰) in the top-left corner of the window.
File Operations
New Pipeline
- Shortcut:
Ctrl+N(Windows/Linux),Cmd+N(Mac) - Description: Creates a new, empty pipeline. If you have unsaved changes, you’ll be prompted to save first.
Save Pipeline
- Shortcut:
Ctrl+S(Windows/Linux),Cmd+S(Mac) - Description: Saves the current pipeline to its existing location. If the pipeline hasn’t been saved before, opens the “Save As” dialog.
- Note: The file path is tracked automatically after first save.
Save Pipeline As…
- Shortcut:
Ctrl+Shift+S(Windows/Linux),Cmd+Shift+S(Mac) - Description: Opens a file dialog to save the pipeline with a new name or location.
- File Format:
.json(Succession Pipeline Files)
Save to Path Root
- Shortcut:
Ctrl+Alt+S(Windows/Linux),⌘+⌥+S(Mac) — saves to thelibroot specifically - Description: Opens the save dialog already pointed at one of your configured path roots, so a graph meant for a shared library does not have to be navigated to by hand. The submenu lists every root you have configured; with none configured it opens Settings.
- File Format:
.json(Succession Pipeline Files)
Load Pipeline
- Shortcut:
Ctrl+O(Windows/Linux),Cmd+O(Mac) - Description: Opens a file dialog to load an existing pipeline from disk.
- File Format:
.json(Succession Pipeline Files)
New Solution
- Shortcut:
Ctrl+Shift+N(Windows/Linux),Cmd+Shift+N(Mac) - Description: Creates a new empty solution file (
.succsln) that groups multiple pipeline graphs together. Opens a file-save dialog to choose a location and name.
Open Solution
- Shortcut:
Ctrl+Shift+O(Windows/Linux),Cmd+Shift+O(Mac) - Description: Opens an existing
.succslnsolution file. All graphs listed in the solution appear in the Solution Panel in the left sidebar.
See Solutions Guide for detailed information.
Tools
Open Console
- Shortcut: None
- Description: Opens the console window showing real-time pipeline execution logs.
- Features:
- Always-on-top window
- Resizable
- Shows execution progress, errors, and debug information
Help Menu
The Help submenu contains documentation, settings, licensing, and about information.
Documentation
- Description: Opens the Project Succession documentation in your default web browser.
- Location: Opens the
docs/index.htmlfile packaged with the application. - Contents: Node reference, user guides, and tutorials.
Settings
- Description: Opens the Settings dialog where you can configure:
- Backend connection settings
- DCC tool integrations (Maya, Blender, Houdini, etc.)
- Vault secrets (API keys, passwords, etc.)
See Settings Guide for detailed information.
Licensing
- Description: Opens the Licensing dialog to manage your subscription.
- Features:
- View license status and details
- Manage subscription
- View expiration dates
- Log out of your account
See Licensing Guide for detailed information.
About
- Description: Opens the About dialog with application information.
- Contents:
- Version number
- Copyright information
- Credits
- Links to website and social media
Report A Bug
- Description: Opens the bug report dialog to submit issues directly to me.
- Required Information:
- Description of the issue
- Steps to reproduce
- Expected vs actual behavior
Pipeline Execution
While not in the main menu, pipeline execution is controlled through:
Execute Button
- Location: Top-center of the work area
- Function: Starts pipeline execution
- Allows for dropdown to only load a pipeine or stop the currently running pipeline.
Menu Behavior
Auto-Close
- Menus automatically close when you click outside them
- Menus close after selecting an action
- Hover delay: Menus stay open briefly when moving mouse between menu and submenus
Keyboard Navigation
- Press
Escto close the menu - Arrow keys work in some dialogs
Related Topics
- Keyboard Shortcuts - Keyboard alternatives to menu commands
- Settings Guide - Detailed settings documentation
- Licensing Guide - License management
- Working with Nodes - Node operations