Storm Dragon 8782d53d03 Updated README.

2024-12-10 12:32:09 -05:00

4.4 KiB

Raw Permalink Blame History

Fenrir

A modern, modular, flexible and fast console screenreader. It should run on any operating system. If you want to help, or write drivers to make it work on other systems, just let me know. This software is licensed under the LGPL v3.

OS Requirements

Linux (ptyDriver, vcsaDriver, evdevDriver)
macOS (ptyDriver)
BSD (ptyDriver)
Windows (ptyDriver)

Core Requirements

python3 >= 3.3
screen, input, speech, sound drivers dependencies see "Features, Drivers, Extras".

Features, Drivers, Extras, Dependencies

Input Drivers:

"evdevDriver" input driver for linux evdev

python-evdev >=0.6.3 (This is commonly referred to as python3-evdev by your distribution)
python-pyudev
loaded uinput kernel module
ReadWrite permission
- /dev/input
- /dev/uinput

"ptyDriver" terminal emulation input driver

python-pyte

Screen Drivers:

"vcsaDriver" screen driver for linux VCSA devices

python-dbus
Read permission to the following files and services:
- /sys/devices/virtual/tty/tty0/active
- /dev/tty[1-64]
- /dev/vcsa[1-64]
- read logind DBUS

"ptyDriver" terminal emulation driver

python-pyte

Speech Drivers:

"genericDriver" (default) speech driver for sound as subprocess:

espeak or espeak-ng

"speechdDriver" speech driver for Speech-dispatcher:

Speech-dispatcher
python-speechd

"emacspeakDriver" speech driver for emacspeak

emacspeak

Sound Drivers:

"genericDriver" (default) sound driver for sound as subprocess:

"gstreamerDriver" sound driver for gstreamer

gstreamer >=1.0
GLib

Extras:

spellchecker

python-pyenchant
aspell-YourLanguageCode (example aspell-en for us English)

Unix daemon (also needed for Systemd):

python-daemonize

Modify system volume:

pyalsaaudio (needs libasound2's headers).

installation

If there is a package for your distrobution of choice, please let us know so we can add it here.

Archlinux: PKGBUILD in AUR
- fenrir: stable release
- fenrir-git: Bleeding edge release
Manual:
- install "espeak" and "sox" with your package manager
- sudo pip install -r requirements.txt
- run install.sh or uninstall.sh as root
You can also just run it from Git without installing: Requires root privileges

cd src/fenrir/ sudo ./fenrir

Settings "settings.conf" is located in the "config" directory or after installation in /etc/fenrir/settings. Take care to use drivers from the config matching your installed drivers. By default it uses:

sound driver: genericDriver (via sox, could configured in settings.conf)
speech driver: genericDriver (via espeak or espeak-ng, could configured in settings.conf)
input driver: evdevDriver

Configure pulseaudio

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.

just run the configuration script twice (once as user, once as root):

/usr/share/fenrirscreenreader/tools/configure_pulse.sh
sudo /usr/share/fenrirscreenreader/tools/configure_pulse.sh

The script is also located in the tools directory in git

Configure pipewire

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.