storm/fenrir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation for stand-alone pipewire or pulse configuration scripts.

Browse Source
This commit is contained in:
Storm Dragon
2025-08-04 14:24:41 -04:00
parent 73f67c2a04
commit 69eade3327
1 changed files with 41 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README.md
View File

@ -640,30 +640,57 @@ send_fenrir_command("setting set speech#rate=0.9")
- Check Fenrir debug logs: `/var/log/fenrir.log` - Check Fenrir debug logs: `/var/log/fenrir.log`
- Test with simple command: `echo "command interrupt" | socat - UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock` - 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. 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.
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.
just run the configuration script twice (once as user, once as root): ### Quick Setup - Direct Script Download
/usr/share/fenrirscreenreader/tools/configure_pulse.sh For non-Fenrir users or quick setup, download and run these scripts directly:
sudo /usr/share/fenrirscreenreader/tools/configure_pulse.sh
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. # Run twice: once as user, once as root
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. ./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 ### Using Installed Scripts
sudo /usr/share/fenrirscreenreader/tools/configure_pipewire.sh
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 ## Command Line Options