From 69eade33272309d270ac43df8abd16999f5f1867 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Mon, 4 Aug 2025 14:24:41 -0400 Subject: [PATCH] Updated documentation for stand-alone pipewire or pulse configuration scripts. --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 41 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 48a2cd79..5a6eda25 100644 --- a/README.md +++ b/README.md @@ -640,30 +640,57 @@ send_fenrir_command("setting set speech#rate=0.9") - Check Fenrir debug logs: `/var/log/fenrir.log` - Test with simple command: `echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock` -## Configure pulseaudio +## Audio Configuration -Pulseaudio by default only plays sound for the user its currently running for. As fenrir is running as root, your local user does not hear the sound and speech produced by fenrir. -for this fenrir provides a script to configure pulseaudio to stream the sound played as root to your local user. This is not a issue of fenrir but this is how pulseaudio works. +Both PulseAudio and PipeWire require special configuration to allow console applications running as root (like Fenrir) to route audio to your regular user session. This is normal audio system behavior, not a Fenrir issue. -just run the configuration script twice (once as user, once as root): +### Quick Setup - Direct Script Download - /usr/share/fenrirscreenreader/tools/configure_pulse.sh - sudo /usr/share/fenrirscreenreader/tools/configure_pulse.sh +For non-Fenrir users or quick setup, download and run these scripts directly: -The script is also located in the tools directory in git +#### PulseAudio Configuration +```bash +# Download the script +wget https://raw.githubusercontent.com/storm-dragon/fenrir/master/tools/configure_pulse.sh +chmod +x configure_pulse.sh +# Run twice: once as user, once as root +./configure_pulse.sh +sudo ./configure_pulse.sh +``` -## Configure pipewire +#### PipeWire Configuration +```bash +# Download the script +wget https://raw.githubusercontent.com/storm-dragon/fenrir/master/tools/configure_pipewire.sh +chmod +x configure_pipewire.sh -Pipewire by default only plays sound for the user its currently running for. As fenrir is running as root, your local user does not hear the sound and speech produced by fenrir. -for this fenrir provides a script to configure pipewire to stream the sound played as root to your local user. This is not a issue of fenrir but this is how pipewire works. +# Run twice: once as user, once as root +./configure_pipewire.sh +sudo ./configure_pipewire.sh +``` -just run the configuration script twice (once as user, once as root): +**Direct links:** +- [configure_pulse.sh](https://raw.githubusercontent.com/storm-dragon/fenrir/master/tools/configure_pulse.sh) +- [configure_pipewire.sh](https://raw.githubusercontent.com/storm-dragon/fenrir/master/tools/configure_pipewire.sh) - /usr/share/fenrirscreenreader/tools/configure_pipewire.sh - sudo /usr/share/fenrirscreenreader/tools/configure_pipewire.sh +### Using Installed Scripts -The script is also located in the tools directory in git +If you have Fenrir installed, the scripts are available at: + +**PulseAudio:** +```bash +/usr/share/fenrirscreenreader/tools/configure_pulse.sh +sudo /usr/share/fenrirscreenreader/tools/configure_pulse.sh +``` + +**PipeWire:** +```bash +/usr/share/fenrirscreenreader/tools/configure_pipewire.sh +sudo /usr/share/fenrirscreenreader/tools/configure_pipewire.sh +``` + +**Note:** These scripts work for any console application that needs root audio access, not just Fenrir. ## Command Line Options