mark polyphony parameter as unused
[software/lv2-mdametapiano.git] / README.md
1 # LV2 port of the famous mdaPiano VSTi
2
3 Port
4 Author: rekado
5 Based on: `mda-vst-src-2010-02-14.zip`
6
7 mdaPiano
8 Author: Paul Kellett (paul.kellett@mda-vst.com)
9 http://sourceforge.net/projects/mda-vst/
10
11 ----------------------
12
13 ## About
14
15 This is an attempt to port the mdaPiano VSTi plugin to the LV2 plugin
16 platform. I'd like to thank Paul Kellett for his decision to put the
17 plugin's source code under a free license (see LICENSE for more info).
18
19
20 ## Compiling
21
22 To compile the plugin, just execute the following statement:
23
24 make && sudo make install
25
26 This will copy the compiled plugin to `/usr/local/lib/lv2`.
27
28 **NOTE**: you will need larsl's `lv2-c++-tools` to compile this plugin: http://freecode.com/projects/lv2-c-tools
29
30
31 ## Connecting
32
33 At the current stage you will need an LV2 host to use the plugin. I'm using
34 `lv2_jack_host` during development:
35
36 lv2_jack_host http://elephly.net/lv2/mdaPiano
37
38 You should now be able to connect your MIDI device to the plugin via JACK. Also
39 don't forget to connect the plugin's stereo output to your system's outputs:
40
41 jack_connect system:playback_1 mdaPiano:left
42 jack_connect system:playback_2 mdaPiano:right
43
44 At least this is what I do on my system. I provide a simple connect script with
45 the code which does these things automatically.
46
47
48 ## License
49
50 The original mda VST plug-ins by Paul Kellett are released under the MIT
51 license or under the GPL "either version 2 of the License, or (at your option)
52 any later version". The LV2 port of the mdaPiano plugin by rekado is released
53 under the same licenses.