From 62e289accf94981c7b704ba2092b5b1b1a0c054c Mon Sep 17 00:00:00 2001 From: dvs1 Date: Mon, 14 Oct 2024 11:08:49 +1000 Subject: Update README.md to match the code's help text. --- README.md | 53 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 86dec60..db0b321 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -This is the JackOnAllDevices project, JOAD for short. +This is part of the AllAudioToALSAandJACK project, aataaj for short, +pronounced like "attach". The purpose is to scan for all ALSA / asound audio devices, and hook them -all up to JACK. Then it starts up JACK, and hooks up any joysticks it -finds as MIDI controllers. So any ALSA application gets routed through +all up to ALSA and JACK. Then it starts up JACK, and hooks up any +joysticks it finds as MIDI controllers. So any ALSA application gets routed through JACK. -This is very rough for now, only just started writing it. jackoffall is -particularly crude and violent, lots of killall. +This is very rough for now, only just started writing it. The stop +command is particularly crude and violent, lots of killall. Since it isn't a package yet, some setup is needed. @@ -20,31 +21,43 @@ The packages you need installed are - qjackctl can be used as a visual patchbay, though I prefer catia from the KXStudio repos. -You need to have the snd-aloop kernel module loaded. The jackscanall -script should be run at boot time, put it into /etc/boot.d/. jackonall -should be called on user login. Probably don't need to run jackoffall on +You need to have the snd-aloop kernel module loaded. + +The aataaj.lua script should be run at boot time, put it into +/etc/boot.d/ and activate it with - + +update-rc.d aataaj.lua defaults + +It scans for your sound devices and creates /var/lib/aataaj/asoundrc. +You can run it manually with "aataaj start" each time you need to change +your devices. + + + +"aataaj JACK" should be called on user login. Probably don't need to run "aataaj stop" on user logout. +It starts up JACK and friends, and creates JACK devices for all the +things "aataaj start" found. It creates the cloop and ploop devices that +catch everything ALSA does. Then creates MIDI devices for all your +joysticks. + + Alas ~/.asoundrc doesn't understand ~ or $HOME, or even "try the current directory" it seems. So you have to hard code the path. Make sure your -~/.asoundrc includes something like this (an example is included) - +~/.asoundrc or /etc/asoundrc includes something like this - - + -jackscanall scans for your sound devices and creates -/var/lib/JOAD/asoundrc. Run jackscanall once as root to create that -file, and each time you need to change your devices. -jackonall starts up JACK and friends, and creates JACK devices for all -the things jackscanall found. It creates the cloop and ploop devices -that catch everything ALSA does. Then creates MIDI devices for all your -joysticks. -jackoffall closes down everything jackonall started up. +"aataaj stop" closes down everything "aataaj JACK" started up. + -NOTE - Seems both ALSA and JACK are per user. So you need to run -jackonall and jackoffall for each user. TODO - Leave it running, and hotplug ALSA / asound audio devices. a2jmidid takes care of hotplugging MIDI devices. Though I think I still need to deal with hotplugged joysticks. + +NOTE - Seems both ALSA and JACK are per user. So you need to run +"aataaj JACK" for each user. -- cgit v1.1