Menu Bar

**The Menu Bar provides the basic functions of the software**

* [**Project**](#h2-project)
* [**View**](#h2-view)
* [**Debug**](#h2-debug)
* [**Tools**](#h2-tools)
* [**Permissions**](#h2-permissions)
* [**Help**](#h2-help)

## Project

![](/media/202601/2026-01-14_170908_0625680.22231313837814926.png)

### New Project

---

In VG3, the **Project** is the highest-level entity. A project can contain multiple **Recipes**. There are two types of recipes: **General Recipes** and **Global Recipes**.
*   There can be only **one Global Recipe**, which consists of multiple global flows.
*   There can be **multiple General Recipes**, and each general recipe can contain multiple flows.

For a better understanding, please refer to the structure diagram below:

```mermaid

graph TD
    Project --> Global_Recipe --> Flow1  --> Module1
    Flow1  --> Module3
    Global_Recipe --> Flow2  --> Module2
    Flow2 --> Module4
    Flow2 --> Module5
    Project --> General_Recipe1 -->  Flow3  --> Module6
    Flow3 --> Module7
    Flow3 --> Module8
    General_Recipe1 -->  Flow4  --> Module9
    Flow4 --> Module10
    Project -->  General_Recipe2   -->  Flow5  --> Module11
    Flow5 --> Module12
    General_Recipe2 -->  Flow6   --> Module13
```

When creating a new project, if the user clicks this menu while an unsaved project is open, a prompt will appear asking whether to save before proceeding.
![](/media/202601/2026-01-16_170419_4169770.8696593568636057.png)

Creating a new project requires the user to specify the **Project Name** and **Project Path**.
*   The default project name increments numerically appended to the text "**New Project**".
*   The default path is set to the software installation directory.
*   Upon clicking **OK**, VG3 will immediately open the newly created project.

#### Directory Structure of a New Project
![](/media/202601/2026-01-19_102142_3447590.2363462396471825.png)

*   **cyGlobalData Folder**: Stores global variables, calibration data, various model images, etc., used by the project.
*   **cyRelativeDataRef Folder**: Stores simulation image data for the project. This allows the project to be exported and imported onto another computer to run directly without needing to reset simulation image connection paths.
*   **Global Recipe Folder**: Stores data used by the global recipe.
*   **General Recipe Folder (Default: Recipe 1)**: Stores data used by general recipes.
*   **Project Entry File**: Generally, a project can be opened in various ways. One method is selecting this entry file upon opening, which imports all project information and data.

> **i Supported File Formats**
> *   **.cysln**: Project entry file (introduced above).
> *   **.zip**: Standard project compressed file. Older versions of VG3 exported in .zip format. Due to encoding issues, newer versions of VG3 use the "Quasi-Yi" project compression format.
> *   **.cySlnZip**: Quasi-Yi project compressed file.

### Open Project

---

Selects and imports an existing project. In visual solution design, solutions are often shared; this function allows users to open an existing project for editing and debugging.
If the project version does not match the current VG3 software version (typically when the project version is older), VG3 will prompt the user to convert the project. For specific conversion methods and version information, refer to the [Convert Project](#h3-convert-project) section below.
VG3 supports opening 3 file formats.

### Recently Opened Projects
VG3 saves the last **15** projects used, facilitating easy switching. Older entries are automatically removed when the limit is reached. Users can also manually click to clear all project information to empty this list.

### Open Project Folder
When users need to quickly locate the directory of the currently edited project, clicking this menu instantly jumps to the project's directory location.

### Save Project - Ctrl+S
Saves the project, recipes, flows, and data to the project's original local path.

### Save Project As
Saves the project, recipes, flows, and data to a new path specified by the user. The project is saved as a **.cySlnZip** file, which is a compressed file in the Quasi-Yi format. When using "Open Project," the software automatically recognizes, decompresses, and imports this format.

### Rename Project
Renames the project. Upon success, the project entry file name is changed, which updates the project name displayed in the title bar.

### Switch Recipe
Allows switching between general recipes. To create more recipes or perform advanced operations, enter the **Recipe Management** interface.

### Convert Project
When the project version does not match the VG3 software version, opening the project will trigger a version mismatch warning. In such cases, the **Convert Project** function must be used to upgrade the project version.
*   Typically, this occurs when a project was created/compiled with a **higher version** of the software but is being opened with a **lower version** of VG3. The software will prompt the user to upgrade VG3 to open it normally.
*   For details on various software versions, please refer to [Software Version Description](/doc/592).

## View

![](/media/202601/2026-01-14_171915_7995190.07410849232661021.png)

*   **Reset Window Layout**
    Restores the software layout to its default state. Since VG3 uses a Docker-based layout mode, users can customize the layout structure according to their preferences. For the original layout, see [Software Introduction](/doc/580).

*   **Image Layout**
    *   **Standard Layout**: Displays up to 4 image windows per row; additional windows wrap to the next line. Window positions and layout cannot be adjusted manually.
        ![](/media/202601/2026-01-20_145905_0449660.7654543537062962.png)
    *   **Specify Image Window Position**: Allows manual adjustment of window display positions.
        ![](/media/202601/2026-01-20_145602_8085010.4624296572617642.png)
        ![](/media/202601/2026-01-20_145625_3931320.03017397697485935.png)
        *   Click **Arrange Windows** to quickly restore the layout.
        *   Click **Lock Position** to lock the current window arrangement. Click **Unlock** to resume adjusting window positions.
    *   **Specify Image Arrangement Mode**:
        ![](/media/202601/2026-01-20_145206_4071350.2366671399801985.png)
        Provides **7 modes** of window layouts for quick switching to suit different needs.

*   **Display Settings**
    Other software display settings. For details, please refer to the [Tools](#h3-tools) section below.

## Debug

![](/media/202601/2026-01-14_172010_8547730.7225613916466279.png)

*   **Run**
    Continuously runs all flows of the current recipe, including global flows.
*   **Continuous Test**
    Continuously tests the currently selected flow (the flow displayed in the Function Tree).
*   **Single Test - F5**
    Performs a single test run of the currently selected flow (the flow displayed in the Function Tree).
*   **Emergency Stop**
    Stops all running flows, including general flows and global flows.

## Tools

![](/media/202601/2026-01-14_172106_1245350.4693038754458938.png)

*   **Options Settings**
    ![](/media/202601/2026-01-20_145939_2790520.7462533283481037.png)

| Setting Item | Description | Parameter Explanation |
| --- | --- | --- |
| **Software Startup** | Software startup and theme settings | **Startup Mode:** • **Auto-start on Boot:** Automatically starts when the computer boots. *Note: Only one instance of VG3 can auto-start on a single computer. If multiple are set, the last one configured takes precedence.* • **Manual Start:** Requires manually clicking the VG3 icon to run. **Startup Delay (ms):** Used with Auto-start. Delays VG3 startup by specified milliseconds to allow other software/hardware to load first. **Running Mode:** • **Foreground Mode:** Displays the VG3 editing or runtime interface upon startup. • **Background Mode:** Runs minimized in the background without immediately showing the interface. Users can click the system tray icon to view the interface. *Note: In Background Mode, images are not refreshed.* **After Loading Project:** • **Execute Directly:** Automatically starts running all flows (including global) of the current recipe upon loading. • **Execute after Password:** Prompts for login; executes immediately upon successful login. • **Edit after Password:** Prompts for login; enters editing interface upon successful login (does not run automatically). • **Manual Start:** Enters editing interface directly without login or automatic execution. **Language:** Simplified Chinese, English. *Restart required after change.* **Theme Color:** White, Black. *Restart required if colors appear inconsistent.* **Image Window Background:** None, Mosaic, Light Gray, Dark Gray. • **None:** No background drawing; follows theme color. Low performance cost. • **Mosaic:** Draws alternating black and white squares; good for edge detection. Does not follow theme. Moderate performance cost. • **Light/Dark Gray:** Solid color. Does not follow theme. Lower performance cost than Mosaic. |
| **Software Others** | Software account and other settings | **Software Password:** Reset login passwords for three roles (Admin, Engineer, Operator). Requires Admin privileges. **Sync Flow Trigger with Camera Trigger:** When enabled, changing the camera trigger mode automatically switches the flow execution mode: 1. If flow is "Continuous" (and not a sub-flow) → Switching camera to "Self/Soft Trigger" changes flow to "Wait for Trigger". 2. If flow is "Wait for Trigger" (and not a sub-flow) → Switching camera to "Hardware Trigger" changes flow to "Continuous". **Pop-up Interface on Function Click:** If enabled, clicking a function icon in the Function Tree opens a separate editing window. **Enable Timer Refresh for Global Variable Trees:** If enabled: 1. Global Variable Tree refreshes data via timer when focused or visible. 2. Axis Monitor/Input/Output Trees (Motion Control specific) refresh via timer when focused or visible. *If disabled, these only refresh once upon focus; manual refresh button required otherwise.* **Reset Runtime and Icons on Continuous Run:** Resets function/flow run times and icons when continuous running starts. |
| **Run Settings** | Project runtime settings *Primarily for communication scenarios (TCP Server/Client between VG3 and client software).* | **Call External Software:** Deprecated feature. Configures the startup order between external software and VG3. • **Priority:** Choose whether to start external software first or VG3 first. • **Delay after Call:** Specifies the delay (ms) between starting the priority software and the second software. • **External Software Path:** Selects the .exe path of the external software. |
| **Display Settings** | Project interface display settings | **Refresh Efficiency Control:** • **Dense Refresh [Performance Priority]:** Ensures images are refreshed as timely as possible after detection. • **Dense Refresh [Refresh Priority]:** Ensures immediate image refresh in the window after detection. • **Skip Refresh:** Refreshes images only when the software is idle. • **Disable Image Refresh:** No image or drawing refresh during detection. **Show Function Run Time:** Toggle display of execution time for each function in the Function Tree. **Show Flow Run Time:** Toggle display of execution time for flows and global flows. **Show Function Run Icons:** Toggle display of status icons for functions in the Function Tree. **Show Flow Run Icons:** Toggle display of status icons for flows and global flows. **Disable Auto-Detect on Parameter/ROI Change:** By default, modifying parameters or dragging ROIs triggers automatic detection for that module and downstream modules. Enabling this option disables auto-detection to prevent unexpected crashes, requiring manual "Single Test" clicks to verify changes. |
| **Other Settings** | Other project settings | **Enable Soft Keyboard:** Enables an on-screen keyboard for all-in-one PC usage, replacing physical mouse/keyboard. **Auto Backup Project:** • **Enabled:** Automatically copies the project to the `backupSolution` folder within the project directory upon saving. Keeps the last 3 backups. • **Disabled:** No automatic backup. Users can click "Backup Now" to manually backup. **Show Configuration Runtime Interface after Loading:** If the project has a custom runtime interface, enabling this shows it immediately upon opening. Otherwise, the VG3 editing interface loads. See [Runtime Interface Editing](/doc/597) for details. **Auto-Demote Configuration Permission to Operator:** If a user logs in with higher privileges (Admin/Engineer), they are automatically demoted to "Operator" level after the specified time duration. **Enable Hardware Background Scanning:** • **Disabled:** Hardware scanning stops immediately upon exiting the settings interface. • **Enabled:** Hardware background scanning starts when the project is run. |

### Permissions

![](/media/202601/2026-01-14_172136_1550220.24414159706927063.png)

*   **Login**
    VG3 provides three permission levels: **Administrator**, **Engineer**, and **Operator**.

| Permission Description | Administrator | Engineer | Operator |
| --- | --- | --- | --- |
| Run/Pause Flows | ✅️ | ✅️ | --- |
| Delete/Add/Edit Flows | ✅️ | ✅️ | ❌️ |
| Delete/Add/Edit Functions | ✅️ | ✅️ | ❌️ |
| Edit Global Data/Models | ✅️ | ✅️ | ❌️ |
| Flow Settings - Function Visibility | ✅️ | ❌️ | ❌️ |
| String Monitor | ✅️ | ❌️ | ❌️ |
| Register Monitor | ✅️ | ❌️ | ❌️ |
| Digital I/O Monitor | ✅️ | ❌️ | ❌️ |
| Change Password | ✅️ | ❌️ | ❌️ |

*   **Change Password**
    Only users with **Administrator** privileges can change passwords. They can modify passwords for Administrators, Engineers, and Operators.

### Help

![](/media/202601/2026-01-14_172204_4392640.6584684473521183.png)

*   **Show Help**
    Contact the supplier to obtain assistance.
*   **Lua Manual**
    VG3 provides a scripting language (Lua) for building complex flows or handling inter-function logic. Refer to this manual for syntax and instructions.
*   **About**
    ![](/media/202601/2026-01-29_172300_6439100.689661084277986.png)
    Displays basic software information, including software version, release date, copyright information, and contact email address.

---

Click here to jump to the corresponding Chinese manual page: [Menu Bar](/doc/585)