Canvus Custom Menu Example

This repository provides an example implementation of a custom menu for MultiTaction Canvus software. It demonstrates various menu items and actions that can be configured, including PDF documents, notes, web browsers, logos, and videos.

Overview

The custom menu implementation includes:

• PDF document launchers
• Note creation tools (including a rainbow note set)
• Web browser launchers with various screen resolutions
• Logo and media content
• Video content launchers

Structure

CustomMenu/
├── content/          # Contains all media files (PDFs, images, videos)
├── icons/           # Menu icons
└── menu.yml        # Main menu configuration file

Installation

1. Clone this repository or download the CustomMenu folder
2. Place the CustomMenu folder in your desired location
3. Configure Canvus to use the custom menu:
   • Open %appdata%\MultiTaction\canvus\mt-canvus.ini
   • Locate the Custom Menu section
   • Add the full path to CustomMenu\menu.yml
   • Example:

     [custom-menu]
     config-file=C:\Path\To\CustomMenu\menu.yml

4. Restart Canvus for the changes to take effect

Menu Configuration

The menu.yml file defines the menu structure using the following format:

• tooltip: Display name for the menu item
• icon: Path to the icon file
• items: Submenu items
• actions: Actions to perform when the menu item is selected

Example Configuration

- tooltip: 'Menu Item'
  icon: 'icons/example.png'
  actions:
    - name: 'create'
      parameters:
        type: 'image'
        source: 'content/example.png'
        scale: 0.33

Requirements

• MultiTaction Canvus software
• Appropriate media content in the content folder
• Menu icons in the icons folder

Notes

• All paths in menu.yml are relative to the CustomMenu folder
• Ensure all referenced content and icon files exist in their respective folders
• Media content is not included in this repository and needs to be added separately

License

This example is provided as-is under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.