Difference between revisions of "NEWMOD Web GUI User Guide"

From MOD Wiki
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 162: Line 162:
 
# Navigate into the folder into which you want to create a new sub-folder (in our example, the "Audio Samples" folder)
 
# Navigate into the folder into which you want to create a new sub-folder (in our example, the "Audio Samples" folder)
 
[[File:AudioFilesFolder FileManager MODWebGUI.png|800px]]
 
[[File:AudioFilesFolder FileManager MODWebGUI.png|800px]]
# <li value="2"> Click on the[[File:CreateDirectoryButton FileManager MODWebGUI.png]| 60px] button
+
# <li value="2"> Click on the[[File:CreateDirectoryButton FileManager MODWebGUI.png| 150px]] button
 +
# A new screen will appear where you will be requested to type the name of the new folder. Following our example, we will type "Water samples"
 +
[[File:DirectoryName_FileManager_MODWebGUI.png |800px]]
 +
# <li value="4"> Click on the "Create" button if you wish to create the new folder or "Cancel" if you wish to abort the process. <br/>
 +
 
 +
After creating the new folder, you will immediately be redirected inside, and you can start uploading your files. In our example, it should be audio files (check [[File_handling#Available_file_types|here]] the supported audio formats) and preferably with water sounds.
 +
 
 +
[[File:WaterSamplesFolder_MODWebGUI.png  |800px]]
  
 
===Plugin Store===
 
===Plugin Store===
[[File:PulginStoreWebGUI.png|800px]]
+
[[File:PluginStoreWebGUI.png|800px]]
  
 
To access the Plugin Store, click on [[File:PluginStoreIcon WebGUI.png|40px]] in the mode selection bar.<br/>
 
To access the Plugin Store, click on [[File:PluginStoreIcon WebGUI.png|40px]] in the mode selection bar.<br/>
 +
 +
By default, the MOD devices come with lots of plugins installed, but there are many more available in the Plugin Store. These plugins are created either by the MOD team or by independent developers. <br/>
 +
 +
We frequently add new plugins to the MOD Plugin Store (either normal releases or in beta), so make sure to give it a look from time to time to check out the new "cool stuff" that can make your MOD even better.
 +
 +
====Installing New plugins====
 +
Installing plugins in your MOD is really simple. <br/>
 +
Let's take, as an example for this guide, the "[https://pedalboards.moddevices.com/plugins/aHR0cDovL2d1aXRhcml4LnNvdXJjZWZvcmdlLm5ldC9wbHVnaW5zL2d4X3F1YWNrXyNfcXVhY2tf GxQuack]"
 +
 +
# Open the Store from the Web GUI
 +
# Browse available plugins or use the search bar in the bottom left corner of the Plugin Store screen
 +
## In our example, we will use the search bar and type "GxQuack"
 +
[[File:PluginStoreSearch_MODWebGUI.png|800px]]
 +
 +
 +
and click Install
 +
# The plugin will be added to the Plugins Bar.
 +
 +
====Buying plugins====
  
 
==Settings==
 
==Settings==

Latest revision as of 09:26, 4 December 2025

Introduction

Welcome to the MOD Web GUI User Guide!
This guide will help you navigate the web-based interface used to control and configure your MOD devices, including the MOD Duo, MOD Duo X, MOD Dwarf, and MOD Desktop.
Whether you're a new user exploring the system for the first time or an experienced musician looking to refine your workflow, this manual provides step-by-step instructions to help you make the most of your MOD experience.

What is the MOD Web GUI?

The MOD Web GUI is a powerful, browser-based interface that allows you to:

  • Create and manage pedalboards using a fully modular approach.
  • Install, remove, and organize plugins from the MOD Plugin Shop.
  • Assign physical controls (knobs, footswitches, MIDI devices, etc.) to parameters for hands-free operation.
  • Save and organize banks & snapshots for seamless performance transitions.
  • Adjust system settings, monitor CPU usage, and update your device firmware.

How Does It Work?

MOD devices run a dedicated audio engine that includes an embedded web server. This web server hosts the MOD Web GUI, which can be accessed from a web browser on a connected computer. The engine processes audio in real-time while allowing users to visually configure and manipulate their signal chain via the Web GUI.

For hardware devices (MOD Duo, MOD Duo X, and MOD Dwarf), the web server runs inside the device itself. Users connect to it over a network (via USB, Ethernet, or Bluetooth) to access the interface. The connection to the network is not made using the Control Chain port (the RJ45 port) on the device.

For MOD Desktop, the MOD audio engine and web server both run on the same computer as the web browser, allowing direct access to the Web GUI without external connections. Despite this difference, the underlying topology remains the same across all platforms.

Compatible Devices

The MOD Web GUI is shared across the following platforms:

  • MOD Duo – Classic dual-footswitch multi-effects processor.
  • MOD Duo X – Advanced performance-focused device with more controls.
  • MOD Dwarf – Compact and versatile effects processor.
  • MOD Desktop – A software-based version of the MOD environment, running on a computer.

While the interface remains consistent across devices, some features, buttons, and objects may differ depending on the device you are connected to. Each MOD device offers different hardware capabilities, which may influence the available GUI elements.

Accessing the WebGUI

To access the Web GUI:

  1. Connect your MOD device to your computer, tablet, or smartphone via USB or Bluetooth (for supported devices).
  2. Open your web browser and navigate to the appropriate address:
  3. Start building and customizing your setup!

If you experience connection issues, visit the Troubleshooting section for assistance.

Navigating the Interface

Web GUI Layout

The MOD Web GUI consists of several key sections that help you manage and configure your device efficiently:

  • Constructor: main view where you can visualise and manage your signal chain, access different menus and overall set your device
  • Pedalboards Library: Quick access to saved pedalboards
  • Banks: organize banks for easy access while using the device in standalone mode
  • File Manager: access to files stored in your device
  • Plugin Store: plugin store where you can install new effects and utilities
  • Snapshots: manage the snapshots of your pedalboard
  • System Status & Settings: Access system settings, monitor CPU usage, and adjust device preferences

Each of these sections is designed to be intuitive, offering drag-and-drop functionality and real-time parameter adjustments.

Constructor

DUOX PedalboardView.png

The Constructor view can be divided into 8 subsections, as you can see in the image above:

  1. Pedalboard name: shows the name of the loaded pedalboard and snapshot
  2. Pedalboard actions bar: access to actions like saving or sharing the pedalboard, managing the snapshots from the current loaded pedalboard, etc.
  3. Inputs: shows a virtual representation of all the physical inputs available on your device hardware
  4. Virtual Pedalboard: visual representation of your signal chain.
  5. Outputs: shows a virtual representation of all the outputs available on your device hardware
  6. Plugins bar: list of installed plugins that can be dragged into the pedalboard.
  7. Mode selector: gives access to the different screens of the WebGUI (Constructor, Pedalboards Library, Banks, File Manager and Plugin Store)
  8. Status bar: gives you access to device actions (like set the tempo, MIDI ports or access the WebGUI settings for your device) and shows you some relevant information about the current status of your device (like CPU and RAM consumption)

Pedalboards Library

WebGUI Pedalboard Library.png

To access the pedalboards library, click on Pedalboards in the mode selection bar.

In the Pedalboards Library view, you can:

  • check all the MOD pedalboards stored in your device
  • load a pedalboard (by clicking on the preview image of the desired pedalboard)

The Pedalboards Library is divided into two categories:

  • User Pedalboards: the pedalboards created and saved by the device users
  • Factory Pedalboards: Pedalboards that come pre-loaded on the device from factory

Please note that the User Pedalboards can be deleted by using the bin icon on the top right corner of each pedalboard preview. (add image showing the icon)

On the other hand, Factory Pedalboards cannot be deleted by the users.

Banks

MODWebGUI Banks.png

To access Banks, click on Banks in the mode selection bar.

Banks allow you to group pedalboards for quick switching while the device is disconnected from the WebGUI.

The MOD devices come loaded with a few Banks from the factory. These banks are not accessible to the users and are only visible on the device.
Yet, the users are welcome and encouraged to create their own banks of pedalboards according to their needs.

Creating and organizing Banks

Dwarf OrganizingBanks.png

Use the Add bank button to create a new bank and name it as you like.
Once created, a new bank is empty and ready to receive your pedalboards. To add pedalboards to your bank, drag them from the right lateral panel into the center of the screen. You can add as many pedalboards as you want. It is also possible to add multiple instances of the same pedalboard to your bank.

You can now navigate through your banks using the Device Menu on the MOD Duo and MOD Duo X and the Navigation Mode on the MOD Dwarf.

On the MOD Duo, you can also use the Footswitches to navigate through the pedalboards of a bank. To do it, activate the option "Foot Nav" on the Settings of your MOD Duo.

File Manager

FileManagerWebGUI.png

To access the File Manager, click on FileManagerIcon WebGUI.png in the mode selection bar.

MOD devices allow file storage for:

  • Audio Loops & Samples
  • Impulse Response (IR) files
  • MIDI sequences
  • Instruments
  • Models

You can learn more about the supported file formats on our File Handling page for MOD devices.

The management of your stored data is done from the File Manager. There, you can upload, download, and delete files or create and download folders.

Note that some plugins can also generate files internally in your device. From the file manager, you can download those files for use in your DAW or on other systems.

How to upload files

  1. Open the File Manager in the Web GUI.
  2. Open the folder for the correct file type (Audio, MIDI, Impulse Response, AIDA DSP Model, etc.) and click on the UploadButtonFileManager WebGUI.png button at the top of the window.
  3. A file browser window with access to your host device file system will open. From there, select the file that you wish to upload.
  4. Use stored files with compatible plugins (a list of plugins using the different types of files can be found here).

How to download a file or a folder

  1. Open the File Manager in the Web GUI.
  2. Locate the file or folder that you wish to download in the MOD file system.
  3. On the list of files and folders, you can find a button with an arrow pointing down for each entry. Just like the following:

DownloadFilesFileManager WebGUI.png

  1. Click on that button, and a file browser window with access to your host device's file system will open.
  2. On that window, select the location on your host device where you wish to store the file.

How to delete a file or a folder

  1. Open the File Manager in the Web GUI.
  2. Locate the file or folder that you wish to delete in the MOD file system.
  3. On the list of files and folders, you can find a button with an "X" for each entry. Just like the following:

DeleteFilesFileManager WebGUI.png

  1. Click on that button, and a new screen will appear asking you to confirm if you want to delete that file or folder. Just like the following:

DeleteFilesConfirmationScreen WebGUI.png

  1. On that screen, click "Yes" if you want to proceed by deleting the file or folder from the internal storage of your MOD device; or "Cancel" if you wish to abort.

How to create a folder

It's not possible to create or delete folders in the main folder of the MOD File system. In other words, you can not create any folder on the root for Audio Files, MIDI Files, Impulse Response Files, Instruments, or Plugin Resources.

Yet, you can create in sub-directories.

Please note that it's important to load the correct type of files into each folder. If you want to create a folder where you will load MIDI Files, you should not create it inside the "Audio Samples" folder, nor load MIDI files there.

Let's take as an example the "Audio Samples" folder in Audio files and create a folder called "Water samples".

  1. Navigate into the folder into which you want to create a new sub-folder (in our example, the "Audio Samples" folder)

AudioFilesFolder FileManager MODWebGUI.png

  1. Click on theCreateDirectoryButton FileManager MODWebGUI.png button
  2. A new screen will appear where you will be requested to type the name of the new folder. Following our example, we will type "Water samples"

DirectoryName FileManager MODWebGUI.png

  1. Click on the "Create" button if you wish to create the new folder or "Cancel" if you wish to abort the process.

After creating the new folder, you will immediately be redirected inside, and you can start uploading your files. In our example, it should be audio files (check here the supported audio formats) and preferably with water sounds.

WaterSamplesFolder MODWebGUI.png

Plugin Store

PluginStoreWebGUI.png

To access the Plugin Store, click on PluginStoreIcon WebGUI.png in the mode selection bar.

By default, the MOD devices come with lots of plugins installed, but there are many more available in the Plugin Store. These plugins are created either by the MOD team or by independent developers.

We frequently add new plugins to the MOD Plugin Store (either normal releases or in beta), so make sure to give it a look from time to time to check out the new "cool stuff" that can make your MOD even better.

Installing New plugins

Installing plugins in your MOD is really simple.
Let's take, as an example for this guide, the "GxQuack"

  1. Open the Store from the Web GUI
  2. Browse available plugins or use the search bar in the bottom left corner of the Plugin Store screen
    1. In our example, we will use the search bar and type "GxQuack"

PluginStoreSearch MODWebGUI.png


and click Install
  1. The plugin will be added to the Plugins Bar.

Buying plugins

Settings

  1. Explanation of each main interface section (Pedalboard, Banks, Store, etc.).

Creating & Managing Pedalboards

Creating a New Pedalboard

To create a new pedalboard:

  1. Click the 'New Pedalboard' button on the interface.
  2. Drag and drop plugins from the Plugins Bar to the Pedalboard View.
  3. Connect plugins by clicking on their input/output nodes and drawing a connection.

Adding and Connecting Plugins

  • Drag a plugin from the Plugins Bar to the Pedalboard View.
  • Connect audio, MIDI, and CV signals between plugins by dragging cables between ports.

Gain Staging and Meter Plugins

Proper gain staging helps maintain optimal sound quality. Use meter plugins to:

  • Monitor signal levels
  • Adjust gain before and after processing stages
  • Prevent clipping and unwanted distortion

Snapshots

Saving and Managing Pedalboards

  • Click 'Save' to store a pedalboard.
  • Organize pedalboards into Banks for easier access.

Assigning Controls & Expanding Functionality

  1. Plugin parameter assignments (knobs, MIDI, CV, Control Chain).
  2. MIDI learn and mapping.
  3. Using Control Chain devices.

Managing Banks & Snapshots

  1. Organizing pedalboards into banks.
  2. Using snapshots for quick switching.

Plugin Management & Store

  1. Installing new plugins.
  2. Plugin compatibility between devices and MOD Desktop.

File Handling

  1. Uploading and managing audio, MIDI, and impulse response files.
  2. Using stored files in plugins.
  3. File compatibility & supported formats.

CV Usage & Modulation

  1. Introduction to Control Voltage (CV) in the MOD system.
  2. Using CV internally vs. hardware CV (Duo X only).
  3. Assigning CV to parameters & modulation control.
  4. Setting up macro-controls with CV.

Advanced Features & Settings

  1. True Bypass feature.
  2. Monitoring CPU Usage & Performance.
  3. System Settings & Backup/Restore.

Troubleshooting & Support

  1. Common connection issues.
  2. MIDI and plugin troubleshooting.
  3. Factory reset & firmware updates.

Appendix: Keyboard Shortcuts, Tips, and Links

  1. List of useful shortcuts for the Web GUI.
  2. Direct links to MOD community resources.