ikatube config reference

the following lists the keys and descriptions for ikatube.json

scale

type: number

description: the scale factor, with 1 being 100%. if unset, the scale factor automatically determined by the system scaling setting.

font_size

[permalink]

type: number

default value: 12

description: the font height.

thumb_size

[permalink]

type: number

default value: 72

description: the thumbnail height.

player_path

[permalink]

type: string

default value: "mpv"

description: the path to run the mpv or vlc player. the path must end with "vlc" or "vlc.exe" to be considered vlc.

note: if "ios_hls" is used for the extractor:

for mpv: seeking past cache does not work for vp9 formats due to ffmpeg bug.
for vlc: video format and resolution are not user selectable; vlc automatically chooses a format to use.

video_format

[permalink]

type: string

default value: "1080p60"

description: the video format for playing. if the specified resolution is not available, a lower resolution format from the same codec will be selected.

opus is used for audio for android extractor, otherwise aac is used.

av1 formats are only available for android extractor, and are still unavailable for some videos.

vp9 formats are only available for android and ios_hls extractors.

single file formats other than 360 are only available for mediaconnect_hls extractor. the extractor only supports single file formats.

1080, 720, 480, 360, 240 - 30fps, h264, aac (single file formats with both audio and video on one stream)
1080p, 720p, 480p, 360p, 240p - 30fps, h264
1080p60, 720p60 - 60fps, h264
2160p_vp9, 1440p_vp9, 1080p_vp9, 720p_vp9, 480p_vp9, 360p_vp9, 240p_vp9 - 30fps, vp9
2160p60_vp9, 1440p60_vp9, 1080p60_vp9, 720p60_vp9 - 60fps, vp9
2160p_av1, 1440p_av1, 1080p_av1, 720p_av1, 480p_av1, 360p_av1, 240p_av1 - 30fps, av1
2160p60_av1, 1440p60_av1, 1080p60_av1, 720p60_av1 - 60fps, av1

sub_language

[permalink]

type: string

default value: "en"

description: subtitle language for playing.

font

[permalink]

type: string

description: the path to the truetype/opentype font for ui elements.

theme_path

[permalink]

type: string

description: the path to the custom theme. a sample theme is included with ikachan.

theme

[permalink]

type: string

default value: "yuuka"

description: the built-in theme to use: can be one of light, dark, yuuka

mascot

[permalink]

type: string

description: the path to the mascot image file to use for the video info viewer.

key_bindings

[permalink]

type: array

description: set custom key bindings. the array contains objects with the following keys to values of string type:

action - the action to perform when the key binding is triggered, can be one of: quit, play_video, view_user_videos, view_recommended_videos, next_page, copy_video_url, copy_video_title, copy_video_description, show_favorites, add_favorites, set_dark_theme, set_light_theme, set_yuuka_theme, set_custom_theme, clear_thumbnail_cache, inc_list_size, dec_list_size, focus_search_input
mod - the modifier keys, can contain zero or more of: CTRL, SHIFT, ALT, SUPER. must be in UPPER CASE letters.
key - the key to bind, must be a space character, a digit, a function key (in F1, F2, ..., F12 format), an UPPER CASE letter, or one of the following options (separated by spaces):

' , - . / ; = [ ] \ ` ESCAPE ENTER TAB BACKSPACE INSERT DELETE LEFT RIGHT UP DOWN PAGEUP PAGEDOWN HOME END

the following is a sample config that binds f2 to set light theme, and ctrl + alt + c to clear thumbnail cache:

"key_bindings": [
  {"action": "set_light_theme", "mod": "", "key": "F2"},
  {"action": "clear_thumbnail_cache", "mod": "CTRL-ALT", "key": "C"}
]

extractor

[permalink]

type: string

default value: "ios_hls"

description: the extractor to use for video url: can be one of android, ios, ios_hls, mediaconnect, mediaconnect_hls

live streams are currently only supported for ios_hls, mediaconnect_hls extractors.

single_click_select

[permalink]

type: bool

default value: false

description: single click to activate an item in the list instead of double click.

show_extra_metadata

[permalink]

type: bool

default value: false

description: show extra metadata (upload date and views) in the list.

save_window_position

[permalink]

type: bool

default value: false

description: save window position on exit to be used on next startup.

smooth_scroll

[permalink]

type: bool

default value: false

description: enable smooth scrolling.

use_edl

[permalink]

type: bool

default value: false

description: use edl for playback, which generates media titles. currently mpv only.

generate_chapters

[permalink]

type: bool

default value: false

description: automatically generate chapters from the video description. currently mpv only.

save_state

[permalink]

type: bool

default value: false

description: save current playlist and video on exit to be loaded on next startup.

infinite_scroll

[permalink]

type: bool

default value: false

description: autoload the next page when scrolled to the bottom.

playlist_width

[permalink]

type: number

default value: 360

description: the playlist width.