Users walk through

1. You need to install (or have installed) the packages:

liblilv-dev
libboost-dev

2. To get the latest development version just do:

git clone https://github.com/brummer10/XUiDesigner.git
cd XUiDesigner
make
sudo make install

3. To update XUiDesigner from the top directory of XUiDesigner do:

git pull
make
sudo make install

4. The controler images are not part of the designer, here is a online resource for controller sprite images: https://www.g200kg.com/en/webknobman/gallery.php

Make sure you download them as horizontal frames (on WebKnobMan: Preference > Horizontal) in order to use them with XUiDesigner. Press "Open with WebKnobMan" and select the frame rate (101 is nice) there. It doesn't have to be 101, it could be any number, but 101 frames works best for any min/max value you want to control. With less frames like 31 it may look as if the knob jumps from one value to the next, especially when you've a wide range to control. Also 101 ensures that you could display the middle position. Download the controler images as png files.

5. Follow these steps to create a LV2 synth plugin with GUI from a Faust dsp-file:

a) Start with a Faust dsp program, lets say: “synthname.dsp”.

b) Add the line “declare options "[nvoices:8]";” at the very start of the program.

c) Run in the Command line:

faust2lv2 -nvoices 8 path/to/synthname.dsp

[Exporting the Faust dsp-file as a (zipped) LV2-plugin 64bit by means of the online Faust IDE is problematic with regard to the MIDI-input.]

d) Put the result synthname.lv2 in the ~/lv2 map.

e) Add knob images and other controler images to the synthname.lv2 GUI by means of XUiDesigner. For using a combobox just use a slider in Faust and then change the controller type in XUiDesigner to combobox and insert the names as combobox entries.

f) Save this in XUiDesigner as the Only UI-Bundle “synthname_ui” to the Desktop.

g) From the top directory of “synthname_ui" do in the Command Line:

make
make install

h) You will now have the two maps “synthname.lv2” and “synthname_ui.lv2” in the ~/.lv2 map.

i) If you now open the plugin synthname.lv2 in a lv2-host then the plugin will appear with the XUiDesigner made GUI.

6. It is not yet possible to change an existing GUI made with XUiDesigner later on after it has already been exported and installed from the Command Line. So you have to finish the GUI in one session, or else start from scratch if you want to change something. - This will issue be solved later.