From 8bada48a09bdfc9d92267ed3ff2303d78da06653 Mon Sep 17 00:00:00 2001 From: Storm Dragon Date: Mon, 4 Aug 2025 14:36:43 -0400 Subject: [PATCH] Fixed errors in README. Moved the audio configuration script stuff nearer the top. --- README.md | 104 +++++++++++++++++++++++++++--------------------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 5a6eda25..bd55dd58 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,58 @@ By default Fenrir uses: - **Input driver**: evdevDriver (Linux) or ptyDriver (other platforms) - **Screen driver**: vcsaDriver (Linux TTY) or ptyDriver (terminal emulation) +## Audio Configuration + +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. + +### Quick Setup - Direct Script Download + +For non-Fenrir users or quick setup, download and run these scripts directly: + +#### PulseAudio Configuration +```bash +# Download the script +wget https://git.stormux.org/storm/fenrir/raw/branch/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 +``` + +#### PipeWire Configuration +```bash +# Download the script +wget https://git.stormux.org/storm/fenrir/raw/branch/master/tools/configure_pipewire.sh +chmod +x configure_pipewire.sh + +# Run twice: once as user, once as root +./configure_pipewire.sh +sudo ./configure_pipewire.sh +``` + +**Direct links:** +- [configure_pulse.sh](https://git.stormux.org/storm/fenrir/raw/branch/master/tools/configure_pulse.sh) +- [configure_pipewire.sh](https://git.stormux.org/storm/fenrir/raw/branch/master/tools/configure_pipewire.sh) + +### Using Installed Scripts + +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. + ## Getting Started ### Basic Usage @@ -640,58 +692,6 @@ 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` -## Audio Configuration - -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. - -### Quick Setup - Direct Script Download - -For non-Fenrir users or quick setup, download and run these scripts directly: - -#### 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 -``` - -#### PipeWire Configuration -```bash -# Download the script -wget https://raw.githubusercontent.com/storm-dragon/fenrir/master/tools/configure_pipewire.sh -chmod +x configure_pipewire.sh - -# Run twice: once as user, once as root -./configure_pipewire.sh -sudo ./configure_pipewire.sh -``` - -**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) - -### Using Installed Scripts - -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 Fenrir supports several command-line options for different use cases: