Zynthian MOD-GUI Guide - Revision history

Jofemodo: Jofemodo moved page Zynthian modgui Guide to Zynthian MOD-GUI Guide

2018-11-29T02:11:53Z

Jofemodo moved page Zynthian modgui Guide to Zynthian MOD-GUI Guide

Jofemodo: /* What is a modgui? */

2018-02-17T16:01:35Z

What is a modgui?

Gmeader: /* What is MOD-UI? */

2017-08-15T23:13:33Z

What is MOD-UI?

Wirtz at 11:38, 27 April 2017

2017-04-27T11:38:55Z

Wirtz at 11:37, 27 April 2017

2017-04-27T11:37:36Z

Wirtz at 11:36, 27 April 2017

2017-04-27T11:36:41Z

Wirtz at 11:35, 27 April 2017

2017-04-27T11:35:38Z

Wirtz at 11:35, 27 April 2017

2017-04-27T11:35:10Z

Wirtz at 11:34, 27 April 2017

2017-04-27T11:34:16Z

Wirtz at 11:33, 27 April 2017

2017-04-27T11:33:19Z

@@ Line 9: / Line 9: @@
 ==What is a modgui?==
-As I said: MOD-UI is based on LV2 plugins. For interacting with the LV2-plugin the default icon in MOD-UI is a tin (looks like a tin for fish). But plugins also have different parameters and they should look not the same. Here is the point where modgui is used. In fact it is an addition to the description of the plugin plus some graphic data and stylesheets. The description is written down in text files in the [https://de.wikipedia.org/wiki/Turtle_(Syntax) Turtle-Syntax].
+As I said: MOD-UI is based on LV2 plugins. For interacting with the LV2-plugin the default icon in MOD-UI is a tin (looks like a tin for fish). But plugins also have different parameters and they should look not the same. Here is the point where '''modgui''' is used. In fact '''modgui''' is an addition to the description of the plugin plus some graphic data and stylesheets. The description is written down in text files in the [https://de.wikipedia.org/wiki/Turtle_(Syntax) Turtle-Syntax].
 ==What is MOD-SDK?==

@@ Line 2: / Line 2: @@
 ==What is MOD-UI?==
-[http://www.moddevices.com MOD-UI] is an open-source web-gui for LV2 plugins. It is written and maintained by [http://www.moddevices.com http://www.moddevices.com]. They sell a very nice effect, which uses lots of free LV2-plugins and is configurable via USB-ethernet. MOD-UI is open-source, too, so Zynthian uses it also as one of several usable engines. In MOD-UI you can drag & drop LV2-plugins of several type (modulators, equalizer, generators (=> synths), distortions, voice effects, vocoders, ...) and connect them together in a way which is really intuitive and easy.
+[http://www.moddevices.com MOD-UI] is an open-source web GUI for LV2 plugins.
 ==What is a modgui?==

← Older revision		Revision as of 11:38, 27 April 2017
Line 46:		Line 46:

	===The hard but very nice looking way===		===The hard but very nice looking way===
−	You can also create your own images and stylesheets by hand. Take a look on some generated modguis of other plugins and try... sorry - I have ~~not more~~ information about ~~his~~ - but perhaps ~~_you_~~ want to write how to do this?	+	You can also create your own images and stylesheets by hand. Take a look on some generated modguis of other plugins and try... sorry - I have no information about this - but perhaps '''you''' want to write the article how to do this?

@@ Line 39: / Line 39: @@
 ===The nicer way===
 ''(This is not fully tested and documented - will do this soon (hopefully))''
-You can pimp the generated images: Go inside the folder of the generated modgui and edit the images with GIMP or something else. This has the disadvantage that the screenshots are not showing the changed images anymore. No problem: You can generate them by hand on your Zynthian:
    /zynthian/zynthian-sw/mod-sdk/make_screenshot.py /zynthian/zynthian-plugins/lv2/<YOUR-PLUGIN-FOLDER>

@@ Line 31: / Line 31: @@
 That's it! Congratulations!
-Ahhh - one thing: Store the generated modgui on antoher computer - or better: distribute it! How to do that? First you have to copy the files from your Zynthian to your main computer. I am doing this with
+Ahhh - one thing: Store the generated modgui on another computer - or better: distribute it! How to do that? First you have to copy the files from your Zynthian to your main computer. I am doing this by:
    scp -r root@<YOUT-ZYNTHIAN-IP>/zynthian/zynthian-plugins/lv2/<LV2-PLUGIN-NAME>.modgui .

@@ Line 27: / Line 27: @@
 On the sub-page ''Settings'' you can advise the initial parameters for this plugin.
-And now: ''Deploy'' - a very nice feature. If there is not the right IP-address (including the port!) of your Zynthian in the text field: edit/change this field! After deploying you cannot see the new icons. You first have to reload MOD-UI/mod-host: go to the shell and enter '''systemctl restart mod-host && systemctl restart mod-ui'''. After reloading the web-page of MOD-UI you should see the generated icons. Try to move it to the pedalboard and try the knobs if they are working.
+And now: ''Deploy'' - a very nice feature. If there is not the right IP-address (including the port!) of your Zynthian in the text field: edit/change this field! After deploying you cannot see the new icons right now. You first have to reload MOD-UI/mod-host: go to the shell and enter '''systemctl restart mod-host && systemctl restart mod-ui'''. After reloading the web-page of MOD-UI you should see the generated icons. Try to move it to the pedalboard and try the knobs if they are working.
 That's it! Congratulations!

@@ Line 21: / Line 21: @@
 Ok. This is really easy: Go to '''http://<YOUR-ZYNTHIAN-IP>:9000'''. You see a selection-box with ''Select-Bundle''. Choose the LV2-plugin (bundle) which you want to edit. You get a page with an index for sub-pages and some information about the selected plugin. Now you can walk through the sub-pages.
-The most important page is the 2nd: ''Icon''. When you select it you get a button named ''Launch Wizard''. After pressing you get a sub-window where you can choose the box-style, box color, knob-style and panel-layout. I think trying around is the best way to learn what is useful and what not. You should have in mind that plugins have different parameters and mapping all or nothing to knobs and/or select boxes may not be the best way. So I think the best way is to go to the next step (button ''Next''). It shows all the parameters and how they will be mapped to the current nulber of knobs/select-boxes. Think about which parameters will be useful to have directly on top of the plugin and which not and map them (e.g. I will try to map Volume to the first button if it is available). Perhaps you have to switch ''Back'' and ''Next'' several times until you get what you want. On the last step you can create the ''screenshots''. Do this if you like - but you can also do this later. Now press ''Finish'' and you get back to the main pages.
+The most important page is the 2nd: ''Icon''. When you select it you get a button named ''Launch Wizard''. After pressing you get a sub-window where you can choose the box-style, box color, knob-style and panel-layout. I think trying around is the best way to learn what is useful and what not. You should have in mind that plugins have different parameters and mapping all or nothing to knobs and/or select boxes may not be the best way. So I think the best way is to go to the next step (button ''Next''). It shows all the parameters and how they will be mapped to the current nulber of knobs/select-boxes. Think about which parameters will be useful to have directly on top of the plugin and which not and map them (e.g. I would try to map Volume to the first button if it is available). Perhaps you have to switch ''Back'' and ''Next'' several times until you get what you want. On the last step you can create the ''screenshots''. Do this. Now press ''Finish'' and you get back to the main pages.
 If you switch to the next sub-page (''Icon screenshot'') you can generate the screenshots, too.