Build and deploy (install) a plugin

From MOD Wiki
Jump to navigation Jump to search

MOD has an online service that connects to your MOD device over the local network and helps plugin developers to build and share their own plugins, based on the format used in the MOD Plugin Builder.

Build from a makefile (.mk)

To build directly from a makefile, you should use the buildroot page from the online MOD Plugin Builder: http://builder.mod.audio/buildroot

With that page opened, you should:

  1. start by connecting your MOD device to the same computer (make sure that your device runs at least the 1.13 version of the MOD OS);
  2. Upload your .mk files on the left of the screen;
    1. if you wish to create a persistant sharable link for your plugins, so you can share it with other users, check the box for that;
  3. Click on "Build"

If everything is correct with your files, a build of your plugin will be made for each of the MOD devices (MOD Dwarf, MOD Duo X and MOD Duo).
You can then click on "Install" and install it on the MOD device that you have connected and/or share the link that opened up if you had the "Create shareable, persistent link" option checked.

Build a Pure Data, Max Gen~ or Faust based plugin

If you developed your plugin using Pure Data, Max Gen~, or Faust and want to build it and install it in your MOD device, you should head up to http://builder.mod.audio/

There, you will see a first window to define which of the three is your plugin based on.

  1. Click on the correct option for what your plugin is based on;
  2. A new window will show up where you should load your plugin file and input some metadata regarding your plugin (name, brand, plugin category, etc.)
    1. if you wish to create a persistent shareable link for your plugins, so you can share it with other users, check the box for that;


Note: Although this is a screenshot of the MaxGen~ based plugins page, all the others have similar pages.

  2. Click on "Build"

If everything is correct with your files, a build of your plugin will be made for each of the MOD devices (MOD Dwarf, MOD Duo X and MOD Duo).
You can then click on "Install" and install it on the MOD device that you have connected and/or share the link that opened up if you had the "Create shareable, persistent link" option checked.

Installing plugins via SSH

To install LV2 plugins in your MOD device, you should:

  1. Connect the MOD device in which you want to install the plugin to the computer
  2. Open the terminal app of your computer
  3. Run the following command:
scp -rp <path to plugin folder> root@192.168.51.1:/root/.lv2
    1. replace "<path to plugin folder>" with the path for the .lv2 folder on your computer, where the plugin that you wish to install is. For example, "/Users/joaoneves/Desktop/MOD_new_plugins/MDW/boreas.lv2"
    2. that would make the following command:
scp -rp /Users/joaoneves/Desktop/MOD_new_plugins/MDW/boreas.lv2 root@192.168.51.1:/root/.lv2
  1. push "Enter"
  2. input the MOD password. It should be: mod
  3. reboot your MOD device
Retrieved from "https://wiki.mod.audio/index.php?title=Build_and_deploy_(install)_a_plugin&oldid=17114"