trilader
/
yttui
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A TUI to monitor YouTube channels
56 Commits 1 Branch 0 Tags 701 KiB
C++ 78%
C 20.7%
Meson 1.3%
Go to file
Daniel Schulte 9ae8dff7d9 Move almost all of main.cpp to application.cpp and add standalone yttui.cpp 2020-12-16 19:41:58 +01:00
subprojects Add wrapfile to fetch get the nlohmann_json library when not installed 2020-12-01 23:23:38 +01:00
.gitignore Add wrapfile to fetch get the nlohmann_json library when not installed 2020-12-01 23:23:38 +01:00
COPYING Add license 2020-11-28 15:40:46 +01:00
README.md Clarify README.md regarding configuration file format 2020-12-02 23:24:51 +01:00
application.cpp Move almost all of main.cpp to application.cpp and add standalone yttui.cpp 2020-12-16 19:41:58 +01:00
application.h Move almost all of main.cpp to application.cpp and add standalone yttui.cpp 2020-12-16 19:41:58 +01:00
db.cpp Add license 2020-11-28 15:40:46 +01:00
db.h Add license 2020-11-28 15:40:46 +01:00
meson.build Move almost all of main.cpp to application.cpp and add standalone yttui.cpp 2020-12-16 19:41:58 +01:00
subprocess.h Add watchCommand config option 2020-11-26 19:30:26 +01:00
tui.cpp Split TUI init code and prepare for embedded application version 2020-12-16 19:38:31 +01:00
tui.h Split TUI init code and prepare for embedded application version 2020-12-16 19:38:31 +01:00
yt.cpp Show video channel name column when viewing virtual channels 2020-12-06 19:40:10 +01:00
yt.h Show video channel name column when viewing virtual channels 2020-12-06 19:40:10 +01:00
yttui.conf.example Add auto refresh support 2020-12-02 23:13:57 +01:00
yttui.cpp Move almost all of main.cpp to application.cpp and add standalone yttui.cpp 2020-12-16 19:41:58 +01:00

README.md

yttui

This is a TUI tool to monitor YouTube channels for new videos and keep track of which ones you've watched already. This tool is work in progress and some functions might not work (correctly).

Building

Requirements:

  • Linux (other platforms are untested and likely require additional work)
  • A modern, C++17 capable compiler
  • meson
  • ninja
  • pkg-config
  • Installed (it may also be required to install separate development packages) and accesible via pkg-config:

How to build

  1. Create a build folder.
  2. Configure the project by running e.g. meson setup /path/to/build/dir in the source directory. See meson setup --help for available configuration options.
  3. Build the application with meson compile -C /path/to/build/dir.
  4. You can now start the application by running /path/to/build/dir/yttui (but have a look at the configuration options first).
  5. Optionally you can install the application by running meson install -C /path/to/build/dir.

Getting started

  1. Build (and optionally install) the application
  2. Get a YouTube API key.
  3. Create a configuration file in JSON format.
    • You can either put it next to the application binary or in $HOME/.config/yttui.conf
    • Have a look at yttui.conf.example. It contains all possible configuration options and is a good place to start.
    • Configuration default values are described in "Configuration options".
  4. Start the application. You can press F1 at any time to get help and C-q (holding down the control key and pressing q) to quit.

Configuration options

Option Description Default value Required
apiKey YouTube API Key ✓
extraHeaders Extra HTTP headers to send to YouTube. This is a JSON array of objects containing "key" and "value". Will be sent with each API requres. [] ✘
database Path of channel/video database $HOME/.local/share/yttui.db ✘
watchCommand Command executed to watch a video. {{vid}} will be replaced by the Id of the video to watch. ["xdg-open", "https://youtube.com/watch?v={{vid}}"] ✘
notifications Object describing notification settings {} ✘
autoRefreshInterval Automatically refresh all channels every X seconds (and after 30 seconds of inactivity). -1 to disable. -1 ✘

Notifcation options

The notifications entry can have the following sub-options:

Option Description Default value Required
channelNewVideoCommand Gets executed when refreshing a single channel and there is one new videos. {{channelName}} will be replaced with the name of updated channel, {{title}} with the title of the new video. [] ✘
channelNewVideosCommand Gets executed when refreshing a single channel and there are multiple new videos. {{channelName}} will be replaced with the name of updated channel, {{newVideos}} with the number of new videos. [] ✘
channelsNewVideosCommand Gets executed when refreshing multiple channels and there are new videos. {{updatedChannels}} will be replaced with the number of updated channels, {{newVideos}} with the number of new videos across all refreshed channels. [] ✘