aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorcbdev <cb@cbcdn.com>2020-02-28 18:53:45 +0100
committercbdev <cb@cbcdn.com>2020-02-28 18:53:45 +0100
commitf49c46c184ecdd5209f1fd9df47daed0acfae728 (patch)
tree77b86db4ac7387a618a5bc7bb2aadf6f3a7d7ed2
parentd35415760f9efcb482ebe3480463ee6f7b5a9735 (diff)
downloadmidimonster-f49c46c184ecdd5209f1fd9df47daed0acfae728.tar.gz
midimonster-f49c46c184ecdd5209f1fd9df47daed0acfae728.tar.bz2
midimonster-f49c46c184ecdd5209f1fd9df47daed0acfae728.zip
Update README to reflect all backends, add notes for building Lua on Windows
-rw-r--r--README.md19
-rw-r--r--backends/lua.md10
2 files changed, 20 insertions, 9 deletions
diff --git a/README.md b/README.md
index 4d0b052..2af26cf 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
# The MIDIMonster
-
<img align="right" src="/MIDIMonster.svg?raw=true&sanitize=true" alt="MIDIMonster Logo" width="20%">
[![Build Status](https://travis-ci.com/cbdevnet/midimonster.svg?branch=master)](https://travis-ci.com/cbdevnet/midimonster)
@@ -11,17 +10,19 @@ tool for multi-channel absolute-value-based control and/or bus protocols.
Currently, the MIDIMonster supports the following protocols:
-| Protocol | Operating Systems | Notes | Backends |
-|-------------------------------|-----------------------|-------------------------------|-------------------------------|
+| Protocol / Interface | Operating Systems | Notes | Backends |
+|-------------------------------|-----------------------|-------------------------------|---------------------------------------|
| MIDI | Linux, Windows, OSX | Linux: via ALSA/JACK, OSX: via JACK | [`midi`](backends/midi.md), [`winmidi`](backends/winmidi.md), [`jack`](backends/jack.md) |
-| ArtNet | Linux, Windows, OSX | Version 4 | [`artnet`](backends/artnet.md)|
-| Streaming ACN (sACN / E1.31) | Linux, Windows, OSX | | [`sacn`](backends/sacn.md) |
-| OpenSoundControl (OSC) | Linux, Windows, OSX | | [`osc`](backends/osc.md) |
+| ArtNet | Linux, Windows, OSX | Version 4 | [`artnet`](backends/artnet.md) |
+| Streaming ACN (sACN / E1.31) | Linux, Windows, OSX | | [`sacn`](backends/sacn.md) |
+| OpenSoundControl (OSC) | Linux, Windows, OSX | | [`osc`](backends/osc.md) |
| OpenPixelControl | Linux, Windows, OSX | 8 Bit & 16 Bit modes | [`openpixelcontrol`](backends/openpixelcontrol.md) |
-| evdev input devices | Linux | Virtual output supported | [`evdev`](backends/evdev.md) |
-| Open Lighting Architecture | Linux, OSX | | [`ola`](backends/ola.md) |
+| evdev input devices | Linux | Virtual output supported | [`evdev`](backends/evdev.md) |
+| Open Lighting Architecture | Linux, OSX | | [`ola`](backends/ola.md) |
| MA Lighting Web Remote | Linux, Windows, OSX | GrandMA2 and dot2 (incl. OnPC) | [`maweb`](backends/maweb.md) |
-| JACK/LV2 Control Voltage (CV) | Linux, OSX | | [`jack`](backends/jack.md) |
+| JACK/LV2 Control Voltage (CV) | Linux, OSX | | [`jack`](backends/jack.md) |
+| Lua Scripting | Linux, Windows, OSX | | [`lua`](backends/lua.md) |
+| Loopback | Linux, Windosw, OSX | | [`loopback`](backends/loopback.md) |
with additional flexibility provided by a [Lua scripting environment](backends/lua.md).
diff --git a/backends/lua.md b/backends/lua.md
index d01a8c6..b936a99 100644
--- a/backends/lua.md
+++ b/backends/lua.md
@@ -64,3 +64,13 @@ Using these names as arguments to the output and value interface functions works
Output values will not trigger corresponding input event handlers unless the channel is mapped
back in the MIDIMonster configuration.
+
+To build (and run) the `lua` backend on Windows, a compiled version of the Lua library is required.
+For various reasons (legal, separations of concern, not wanting to ship binary data in the repository),
+you will need to acquire a copy of `lua53.dll` (for example by downloading it from the [luabinaries
+project](http://luabinaries.sourceforge.net/download.html).
+
+To build the `lua` backend for Windows, place `lua53.dll` in a subdirectory `libs/` in the project root
+and run `make lua.dll` inside the `backends/` directory.
+
+At runtime, Windows searches for the file in the same directory as `midimonster.exe`.