From 9606983dd5cce1a9a1214f9be50cc0844f7d4407 Mon Sep 17 00:00:00 2001 From: mykola2312 <49044616+mykola2312@users.noreply.github.com> Date: Wed, 1 May 2024 03:58:30 +0300 Subject: [PATCH] fix typos and errors in readme, add more explanation about pulseaudio --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8722dd9..a2a90f9 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,34 @@ # mptv -MPV front-end for IPTV channels to use on Raspberry Pi. +MPV front-end for IPTV channels. Convert Your Raspberry Pi into IPTV receiver. Anything that MPV can play. ## Stack -Java Swing application that crawls and parses M3U playlists, displaying them in graphical menu and opening them in MPV. +Java Swing application that crawls and parses M3U playlists, displaying them in graphical menu and opening them with MPV. Reads IR commands from any TV remote, controlling menu, opening and managing MPV player state. Example configuration ```config.json.example```, rename to ```config.json```. Take look and configure the way You like it. May have multiple IR bind sets, so You can switch between them with ```currentBindSet``` variable. Use ```piir dump``` to dump IR commands from Your TV remote. -Uses [PiIR](https://github.com/ts1/PiIR) for reading TV remote IR signals +Uses [PiIR](https://github.com/ts1/PiIR) for reading TV remote IR signals. + ```pigpio``` must be present in system, and its daemon ```pigpiod``` must be running. Enable it with ```sudo systemctl enable pigpiod``` -Recommended to use Xorg and PulseAudio. PulseAudio default sink must be set to HDMI output. +Recommended to use Xorg and PulseAudio. PulseAudio default sink must be set to HDMI output, with command like ```pactl set-default-sink 1``` -Some configurations files could be found in linux folder to ease Your setup. +Don't forget to enable PulseAudio user service with command ```systemctl --user enable pulseaudio``` + +Some configurations files could be found in ```linux``` folder to help with Your setup. ## Configuration The configuration is a JSON file ```config.json``` -- ```frame``` - GUI window parameters. Note that ```fullscreen`` may not work well in Xorg. +- ```frame``` - GUI window parameters. Note that ```fullscreen``` may not work well in Xorg. - ```db``` - DB configuration. Only supports SQLite. - ```piir``` - PiIR configuration. You must provide path to piir executable in ```exec``` field. ```gpio``` corresponds to GPIO pin. -Note that You must have pigpiod service running. Enable it with ```sudo systemctl enable pigpiod``` ```bindSet``` decribes binds for each remote, select current remote bind set with ```currentBindSet``` field. For bind explanation refer to ```config.json.example``` - ```sources``` - Here You write Your M3U playlist sources. May be either local file or remote URL. Take look at ```config.json.example``` -- ```tasks``` - Adjust here intervals for each task to be executed. If You experience frequent MPV restarts, You may want to adjust ```processService``` to 2 second interval. ```crawler``` task will be executed at 24 hour interval. +- ```tasks``` - Adjust here intervals for each task to be executed. If You experience frequent MPV restarts, You may want to adjust ```processService``` to 2 second interval. ```crawler``` task will be executed once every 24 hours. ### Recommended IR connection to GPIO ![](assets/rpi-ir.webp)