https://www.youtube.com/channel/UCtMVHI3AJD4Qk4hcbZnI9ZQ

link-to-channel
#comment
link-to-channel #best channel

$cache_dir

The directory to store cache files in.
It is highly recommended to only change this if $__is_submenu is 0, or funky things could happen
default: $XDG_CACHE_HOME/ytfzf (or $HOME/.cache/ytfzf)

$hist_file

The file to write watch history to if $enable_hist is 1
It is highly recommended to only change this if $__is_submenu is 0, or funky things could happen
default: $cache_dir/watch_hist

$search_hist_file

The file to write search history to if $enable_search_hist is 1
default: $cache_dir/search_hist

$ytfzf_selected_urls

The file to store the ids of selected video(s) in.
default: $cache_dir/urls

$ytfzf_video_json_file

The file to store the json data of scraped videos.
default: $cache_dir/videos_json

$is_detach

Whether or not to detach the video player from the terminal.
default: 0

$is_audio_only

Whether or not to only play audio.
default: 0

$url_handler

The function/programs to handle the selected videos
It is recommended to not set this variable directly, but rather to use the command load_url_handler
See URL handlers for a list of built-in url handlers default: multimedia_player

$yt_video_link_domain

The domain to play youtube videos from (does not apply to odysee and peertube or youtube playlists)
default: https://www.youtube.com

$info_to_print

The information to print instead of playing a video. The available options for this variable are:

$info_wait_action

The action to do when $info_wait is 1.
Valid actions:

$info_wait

Whether or not to wait for input after printing info.
default: 0

$video_pref

The video preference to use for youtube-dl in mpv.
default: bestvideo

$audio_pref

The audio preference to use for youtube-dl in mpv.
default: bestaudio

$ytdl_pref

The preference to use for youtube-dl in mpv.
default: $video_pref+$audio_pref/best/$video_pref/$audio_pref

$url_handler_opts

Opts to pass to the url handler, by default this will pass extra opts to mpv. This can also be set in the config file with url_handler_opts

$interface

The interface/menu to use.
It is recommended to not use this variable directly, instead use load_interface interface-name
Valid options.

$external_menu_len

The amount of cols in interface_ext, (-D)
default: 210

$fzf_preview_side

The side to show the preview in fzf.
Valid options:

$thumbnail_viewer

The program to display images for thumbnail previews
It is recommended to not use this variable directly, instead use load_thumbnail_viewer viewer
Valid options:

$show_formats

Whether or not to bring up the format selection menu.
default: 0

$format_selection_screen

The format that selection screen will use. Types:

$format_selection_sort

The --format-sort to use in ytdl.
default: height

$enable_submenus

Whether or not to enable submenus,
A submenu is a menu that appears after a playlist or channel is selected. (Currently only supported with youtube/invidious scraper) default: 1

$keep_vars

Whether or not options passed into ytfzf also get passed into submenus

$enable_back_button

Whether or not to enable back button in submenus. default: 1

$submenu_opts

Options to use in submenus. default:

$submenu_scraping_opts

DEPRECATED (use submenu_opts instead) Does the same thing as $submenu_opts default:

$is_sort

Whether or not to sort scraped videos by date in the menu default: 0

$fancy_subs

Whether or not to have a separator between each subscription default: 0

$fancy_subs_left

The text to display on the left of the channel name when fancy_subs is 1. default: -------------

$fancy_subs_right

The text to display on the right of the channel name when fancy_subs is 1. default: $fancy_subs_left

$show_thumbnails

Whether or not to show thumbnails in fzf.
default: 0

$async_thumbnails Whether or not to download thumbnails asynchronously.
Downloading asynchronously will open the menu before all thumbnails are downloaded. default: 0

$skip_thumb_download

Whether or not to skip thumbnail download.
default: 0

$thumbnail_quality

Select the quality of the thumbnails. Currently only supports youtube (uses invidious api).
This does not work for the '-cS' scraper as it scrapes youtube not invidious (use 'SI' instead).
For lower internet speeds it is recommended to use default.
Available options:

$notify_playing

Whether or not to send a notification when a video is about to be played.
default: 0

$is_loop

Whether or not to show the menu after the selected videos have stopped playing.
default: 0

$search_again

Whether or not to make another search after fzf is closed.
default: 0

$download_shortcut

The shortcut to download the selected videos.
default: alt-d

$video_shortcut

The shortcut to watch the selected videos.
default: alt-v

$audio_shortcut

The shortcut to listen to the selected videos.
default: alt-m

$detach_shortcut

The shortcut to use the detach player.
default: alt-e

$print_link_shortcut

The shortcut to use to print the link.
default: alt-l

$show_formats_shortcut

The shortcut to show formats before playing the video.
default: alt-f

$info_shortcut

The shortcut to get all info about the selected video.
default: alt-i

$search_again_shortcut

The shortcut to make another search.
default: alt-s

$shortcut_binds

The keys to listen for in fzf.
default: Enter,double-click,$download_shortcut, $video_shortcut,$detach_shortcut,$print_link_shortcut,$show_formats_shortcut, $info_shortcut,$search_again_shortcut,$custom_shortcut_binds"

next_page_action_shortcut

The shortcut to scrape the next page.
default: ctrl-p

$custom_shortcut_binds

The custom shortcut keys. Automatically appended to $shortcut_binds
If $shortcut_binds is set manually, this must also manually be appended.

$is_auto_select

Whether or not to auto select the first -n videos. (only works if $interface=scripting)
default: 0

$is_random_select

Whether or not to randomly select -n videos. (only works if $interface=scripting)
default: 0

$is_specific_select

Whether or not to select a specific video (use $ scripting_video_count to specify which) (only works if $interface=scripting)
default: 0

$scripting_video_count

The amount of videos to get with -a or -r.
default: 1

$scrape

The website to scrape by default. The currently supported options are:

$multi_search

Whether or not to enable multi search. default: 0

$search_sort_by

The attribute to sort by when searching.

$search_upload_date

Search for videos within the last:

$search_video_duration

Whether or not to search for long or short videos. Possible options:

$search_result_type

The type of results to get.

$nsfw

Whether or not to search for nsfw videos in odysee/O.
default: false

$search_result_features

The features to have on a video (comma separated).

$search_region

The region (country code) to search. default: US

$invidious_instance

The instance of invidious to use.
default: https://vid.puffyan.us

$pages_to_scrape

The amount of pages to scrape on youtube/invidious.
default: 1

$pages_start

The starting page to scrape.
default: 1

$max_thread_count

The amount of threads that can be used while scraping youtube search, playlists, and channels. (this does not apply to the subscription scraper)
default: 20

$odysee_video_search_count

The amount of videos to scrape on odysee.
default: 30

$sub_link_count

The amount of videos to scrape per channel when getting subscriptions.
default: 2

$scrape_search_exclude

The scrapers to not ask for a search query.
Be sure to have a space at the end and beginning of the string.
default: youtube-subscriptions S SI T youtube-trending H history

$custom_scrape_search_exclude

Extra scrapers to not ask for a search query.
This will automatically be appended to $ scrape_search_exclude.
In addition, you do not need spaces at the start, and end, only between scrapers. default:

$gap_space

A number of spaces equal to half the width of your terminal
default: 115 spaces

$enable_hist

Whether or not to keep track of history
default: 1

$enable_search_hist

Whether or not to keep track of search history
default: 1

$search_source

How to get the search query. The builtin values for this are:

$log_level

How much debug information to log.

$thumbnail_debug_log

The log file for thumbnail debug information. default:/dev/null

$useragent

The useragent to use when scraping websites.
default: "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.152 Safari/537.36"

$ytdl_opts

The command-line options to pass to youtube-dl when downloading.

$ytdl_path

Path to youtube-dl or a fork of youtube-dl for downloading.
If yt-dlp is installed that will be preferred over youtube-dl
default: youtube-dl

$long_opt_char

The char to use for long opts.
default: -

$optstring

The string of options to use for the getopts function.
It is highly unrecommended to change this variable, unless you know what you are doing.
default: ac:de:fhi:lmn:qrstu:xADHI:LS:T:W:$long_opt_char:

$YTFZF_CHECK_VARS_EXISTS

Whether or not to check if variables in the environment already exist when setting default options.
This option can not be set in the config, it must be set in your startup shell with export, or before running ytfzf such as: YTFZF_CHECK_VARS_EXISTS=0 ytfzf ...
default:1

$__is_submenu

Whether or not the script is in a submenu.

$__is_fzf_preview

Whether or not the script is running to display an fzf preview

__scrape_count

The current scrape count starting at 1.

external_menu()

When $interface is ext_menu, call this function instead of fzf.
This function takes 1 argument, a prompt string.

get_sort_by()

This function is called to get the value to sort by when $is_sort is 1.
This function takes in a line in the form of "title |channel |duration |views |date |id".

data_sort_fn()

This function sorts the data that is being piped into it.
This function takes no arguments, all data is piped into it.

custom_info_wait_action_<text>()

This function is called if an unknown $info_wait_action is given or read.
<text> should be replaced with the text wanted from $info_wait_action, eg: custom_info_wait_e.
This function takes no arguments.

video_info_text()

This function prints the text for the selection menu.
Must end with a new line,
The url must be the last thing printed.
This function takes no arguments, the relevant variables are listed here:

title
channel
duration
views
date
url

thumbnail_video_info_text()

This function prints text in the preview area of fzf when thumbnails are enabled.
Everything can be printed however you like.
This function takes no arguments, the relevant variables are listed here:

title
channel
duration
views
date
url

thumbnail_video_info_text_<scraper>()

This function is the same as thumbnail_video_info_text() for the scraper specified.

on_no_thumbnail()

This function is run when no thumbnail is found

get_ueberzug_positioning_left()

This function sets the variables, $width, $height, $x, and $y. $x, and $y, should represent cols and lines not pixels.
These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is left.
This function takes 2 arguments:

max_width
max_height

get_ueberzug_positioning_right()

This function sets the variables, $width, $height, $x, and $y.
$x, and $y, should represent cols and lines not pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is right.


This function takes 2 arguments:

max_width
max_height

get_ueberzug_positioning_up()

This function sets the variables, $width, $height, $x, and $y.
$x, and $y, should represent cols and lines not pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is up.


This function takes 2 arguments:

max_width
max_height

get_ueberzug_positioning_down()

This function sets the variables, $width, $height, $x, and $y.
$x, and $y, should represent cols and lines not pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is down.


This function takes 2 arguments:

max_width
max_height

get_swayimg_positioning_left()

This function sets the variables, $x, $y, $img_w, and $img_h.
$x, and $y, should represent pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is left.


This function takes 8 arguments:

img_w
img_h
max_width
max_height
max_height
term_x
term_y
col_px_width
line_px_height

get_swayimg_positioning_right()

This function sets the variables, $x, $y, $img_w, and $img_h.
$x, and $y, should represent pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is right.


This function takes 8 arguments:

img_w
img_h
max_width
max_height
max_height
term_x
term_y
col_px_width
line_px_height

get_swayimg_positioning_up()

This function sets the variables, $x, $y, $img_w, and $img_h.
$x, and $y, should represent pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is up.


This function takes 8 arguments:

img_w
img_h
max_width
max_height
max_height
term_x
term_y
col_px_width
line_px_height

get_swayimg_positioning_down()

This function sets the variables, $x, $y, $img_w, and $img_h.
$x, and $y, should represent pixels.


These variables will be used to position and size the image in the fzf preview when $fzf_preview_side is down.


This function takes 8 arguments:

img_w
img_h
max_width
max_height
max_height
term_x
term_y
col_px_width
line_px_height

search_prompt_menu()

This function asks the user to make a search query, and sets the variable $_search to the query.


This function is called if ytfzf is started without a search. (and is using the default interface)


This function takes no arguments.
    

search_prompt_ext()

This function asks the user to make a search query, and sets the variable $_search to the query.


This function is called if ytfzf is started without a search. (and is using the -D flag)


This function takes no arguments.
    

search_prompt_scripting()

This function asks the user to make a search query, and sets the variable $_search to the query.


This function is called if ytfzf is started without a search. (and is using the -r, -a, or -A flag)


This function takes no arguments.
    

quick_menu()

This function should take user input and echo it back


This function is called with -f, and -q. Or any other time a generic menu is needed. (and the default interface is being used)


This function takes 1 argument, and takes input from stdin


1: The prompt to use.


stdin: the items to choose from (separated by new lines)
    

quick_menu_ext()

This function should do the same thing as quick_menu()


This function is called when quick_menu() would be called, but when -D is enabled.


This function takes 1 argument, and takes input from stdin


1: The prompt to use.


stdin: the items to choose from (separated by new lines)
    

quick_menu_scripting()

This function should do the same thing as quick_menu()


This function is called when quick_menu() would be called, but when -a, -r, or -A is enabled.


This function takes 1 argument, and takes input from stdin


1: The prompt to use.


stdin: the items to choose from (separated by new lines)
    

info_wait_prompt()

The prompt to use when info_wait is enabled.


This function takes no arguments.
    

info_wait_prompt_ext()

Same as info_wait_prompt() when -D is used.


This function takes no arguments.
    

info_wait_prompt_scripting()

Same as info_wait_prompt() when -S, -a, or -A is used.


This function takes no arguments.
    

info_wait_prompt_wrapper()

Call info_wait_prompt_<interface_name>


This function takes no arguments.
    

display_text()

Print text to standard out.


This function takes an unlimited number of arguments to print.
    

display_text_ext()

Print text to standard out.


This function takes an unlimited number of arguments to print.

A URL handler is a function that handles the urls given,


URL handlers should take into account these modifier values,
$video_pref , 
$is_audio_only , 
and
$is_detach

Modifier variables will be piped into a URL handler to allow for URL handlers to be written in any language.


They will be piped in the order shown above separated by spaces.

multimedia_player()

The handler that is called by default.


This function opens either video_player() or audio_player() depending on whether or not


$is_audio_only (-m) is enabled.


This function takes in an unlimited amount of arguments, each of which is a link to a video.
    

video_player()

Plays the urls with a video player


This function takes in an unlimited amount of arguments, each of which is a link to a video.
    

audio_player()

Plays the urls with an audio player


This function takes in an unlimited amount of arguments, each of which is a link to a video.
    

downloader()

Downloads the urls


This function takes in an unlimited amount of arguments, each of which is a link to a video.
    

get_video_format_<name>()

A custom format selection screen


<name> should be the the wanted value of $format_selection_screen


This function should set ytdl_pref


This function takes all urls as separate arguments.
    

on_open_url_handler_<ext>()

This function is run when open_url_handler is called, but before the url handler is actually opened.


This function takes an unlimited number of arguments, each argument is a url that was opened.
    

close_url_handler_<name>

<name> should be the name of the url handler with - replaced with _.


A function that happens after the url handler has finished playing.


The point of this function is to clean up anything that the url handler did.
    

after_close_url_handler_<ext>

A function that happens after the url handler has finished playing, and after
close_url_handler_<name>
has happened.


If
is_detach
is
1
this function may be called immediately after
url_handler
opens.
    

handle_search_history()

This function handles appending the search to the given search file.


This function takes 2 arguments:

parse_search_hist_file()

This function should parse the search history file, and print out each search separated by new lines.


The search history file will be fed through stdin.
    

get_search_from_<src>()

If search_source is set to <src> this function will be called.
This function is expected to set the variable _search to a search query.


This function takes no arguments.
    

on_search()

This function gets called each time a website is scraped.


This function takes 2 arguments:
1


    The search query
2


    The current scrape
    

on_search_<search_query>()

This function gets called each time a website is scraped if the current search matches <search_query>.
This function takes 1 argument.

get_requested_info_<name>()

If <name> is in info_to_print this function will be run.
This function takes no arguments.

handle_playing_notifications()

This function sends a notification for the videos that are about to be played.
This function takes an unknown amount of urls as arguments.

post_scrape()

This function happens after all scraping is complete

post_scrape_<extension-name>()

Same as post_scrape() but for each extension

on_opt_parse()

This function gets called after an option is parsed, and sets variables based the options passed into it. A non 0 exit code will override the default behavior of a specific option.
This function takes 4 arguments:

1


    The current option being parsed
2


    The current option argument being parsed
3


    The unmodified option being parsed.


    For an option such as -a, this value will be the same as $1.


    However, for every --long-option this value will be "-".
4


    The unmodified option argument being parsed.


    For an option such as -c S, this value will be the same as $2.


    However, for every --long-option=value, this value will be -long-option=value.
    

on_opt_parse_<opt_name>()

This function gets called before an option is parsed. A non 0 exit code will override the default behavior of a specific option.
This function takes 3 arguments:

on_post_set_vars()

This function gets called after all vars are set, and all opts are parsed.
This function takes no arguments.

on_clean_up()

This function is called when the script is cleaning up files from the search, or when the script exits.
This function takes no arguments.

handle_custom_keypresses()

This function gets called in the internal handle_keypress() function. This function should return 0 to not override the default handle_keypress() function.
This function takes 1 argument:

1


    The key pressed.
    

handle_custom_post_keypresses()

This function gets called in the internal handle_post_keypress() function, this function should return 0 to not override the default handle_post_keypress() function.
The job of this function is to undo the changes of the last keypress.
This function takes no arguments, it must get the keypress from $keypress_file

handle_keypress_*()

The name of this function should replace the "*" with the name of the shortcut, eg: alt_d
in addition replace any "-" with "_".
This function is called after handle_custom_keypresses() if it returned 0, and the shortcut is not a built-in shortcut.
This function takes 0 arguments.

handle_post_keypress_*()

The name of this function should replace the "*" with the name of the shortcut, eg: alt_d
in addition replace any "-" with "_".
This function is called after handle_custom_post_keypresses() if it returned 0, and the shortcut is not a built-in shortcut.
this function takes 0 arguments.

handle_custom_action()

This function is called when an unknown action (as described in VIDEO JSON FORMAT) is given.
This function takes 1 argument:

    The action.
    

Exit Codes: