Merge pull request #42 from overtone/arne/revive-the-beast-2023

Revive the Beast

.gitignore

@@ -7,3 +7,9 @@ pom.xml
 /data/*jpg
 target
 .DS_store
+native
+.cpcache
+hs_err*.log
+tmp_background.png
+tmp-background.png
+.nrepl-port

README.md

@@ -5,21 +5,68 @@ Digital clone of an analog synthesizer using Overtone and Quil
 
 <img src="https://github.com/overtone/mini-beast/raw/master/doc/minibeast.png" alt="MiniBeast Screenshot" />
 
+## Prerequisites
+
+Install the [Clojure CLI tools](https://clojure.org/guides/install_clojure)
+
 ## Running
-    git clone https://github.com/overtone/mini-beast.git
-    cd mini-beast
-    lein run
+
+```
+git clone https://github.com/overtone/mini-beast.git
+cd mini-beast
+clojure -M -m minibeast.core
+```
+
+This will try to use the Overtone internal (embedded) SuperCollider. There are
+several scenarios in which this may not work (Mac M1/M2, Windows 64 bit, Linux
+with Pipewire). Check the [[Troubleshooting]] section below for how to fix that.
 
 ## Tips
+
 * Make sure your MIDI devices are connected before starting the beast
-* Click on a knob slider, selector, or wheel and adjust the control on your MIDI device.
+* Right click on a knob slider, selector, or wheel and adjust the control on your MIDI device.
 * The beast remembers your control bindings, so once you've bound one control, bind another!
 * You can save and load bindings and presets using the `File` menu.
 
+## Troubleshooting
+
+### Can't start SuperCollider
+
+If the embedded SuperCollider doesn't work for some reason, then [install
+SuperCollider](https://supercollider.github.io/downloads.html) manually. It's
+packaged for virtually every operating system, so check your package manager
+first.
+
+Debian/Ubuntu:
+
+```
+sudo apt-get install supercollider-server sc3-plugins
+scsynth -v
+```
+
+Once `scsynth` is on your path you can try `--sc-boot-external`, or start
+it yourself (`scsynth -u 12345`), then connect to it with `--sc-udp-port 12345`.
+
+On Linux when using PipeWire it might help to run MiniBeast with `pw-jack`, part
+of the `pipewire-jack` package.
+
+```
+scsynth -u 12345
+pw-jack clojure -M -m minibeast-core --sc-udp-port 12345
+```
+
+### It runs but there's no sound
+
+Check that your outputs are connected. On Linux this is done by connecting
+Overtone to your audio interface through Jack or PipeWire. Programs that can do
+this are `qjackctl` (Jack or Pipewire) or `qpwgraph` (Pipewire only).
+
 ## A call for patches
-MiniBeast loads a default patch, but we need your help! There is a world of sounds and timbres waiting to be explored.
-When you happen upon an unusual or interesting patch, please save it and share it. Pull requests work or post them to
-the Overtone [mailing list](http://groups.google.com/group/overtone). 
+
+MiniBeast loads a default patch, but we need your help! There is a world of
+sounds and timbres waiting to be explored. When you happen upon an unusual or
+interesting patch, please save it and share it. Pull requests work or post them
+to the Overtone [mailing list](http://groups.google.com/group/overtone).
 
 Enjoy making new sounds!
 

bb.edn

@@ -0,0 +1 @@
+{:deps {com.lambdaisland/launchpad {:mvn/version "0.17.93-alpha"}}}

bin/launchpad

@@ -0,0 +1,4 @@
+#!/usr/bin/env -S pw-jack bb
+(require '[lambdaisland.launchpad :as launchpad])
+
+(launchpad/main {})

deps.edn

@@ -0,0 +1,10 @@
+{:paths
+ ["src" "data" "presets"]
+
+ :deps
+ {org.clojure/clojure                     {:mvn/version "1.11.1"}
+  overtone/overtone                       {:mvn/version "0.11.0"
+                                           #_#_:local/root "../overtone"}
+  quil/quil                               {:mvn/version "4.3.1323"}
+  commons-collections/commons-collections {:mvn/version "20040616"}
+  org.clojure/tools.cli                   {:mvn/version "1.0.219"}}}