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

type: number

default value: 12

description: the font height.

thumb_size

type: number

default value: 72

description: the thumbnail height.

player_path

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. (fixed in master)
• for vlc: video format and resolution are not user selectable; vlc automatically chooses a format to use.

video_format

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 and android_vr extractors, otherwise aac is used.

av1 formats are only available for android, android_vr, and ios extractors, and are still unavailable for some videos.

vp9 formats are only available for android, android_vr, and ios_hls extractors.

• 1080, 720, 480, 360, 240 - 30fps, h264, aac (single file formats with both audio and video on one stream, web_hls extractor only; android and android_vr extractors only have 360 available)
• 1080_60, 720_60 - 60fps, h264, aac (single file formats with both audio and video on one stream, web_hls extractor only)
• 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

type: string

default value: "en"

description: subtitle language for playing.

font

type: string

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

theme_path

type: string

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

theme

type: string

default value: "yuuka"

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

mascot

type: string

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

key_bindings

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, show_history, 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, focus_playlist
• 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

type: string

default value: "web_hls"

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

live streams are currently only supported for ios_hls and web_hls extractors.

note: android, ios, ios_hls extractors are not recommended and may fail to work. use android_vr, web_hls extractors instead.

note: mediaconnect, mediaconnect_hls extractors are no longer functional.

single_click_select

type: bool

default value: false

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

show_extra_metadata

type: bool

default value: false

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

save_window_position

type: bool

default value: false

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

smooth_scroll

type: bool

default value: false

description: enable smooth scrolling.

use_edl

type: bool

default value: false

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

generate_chapters

type: bool

default value: false

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

save_state

type: bool

default value: false

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

infinite_scroll

type: bool

default value: false

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

playlist_width

type: number

default value: 360

description: the playlist width.

sponsorblock

type: bool

default value: false

description: enable sponsorblock support. currently mpv only.

this generates chapters titled IKATUBE-SPONSOR-SEGMENT for sponsored segments.

to automatically skip sponsored segments, create a lua script with the following content and put it inside the mpv script directory:

mp.observe_property('chapter-metadata/title', 'string', function (_, value)
  if value == 'IKATUBE-SPONSOR-SEGMENT' then
    mp.command('no-osd add chapter 1')
  end
end)

sponsorblock_server

type: string

default value: "sponsor.ajay.app"

description: the address of the sponsorblock server.

allow_hdr

type: bool

default value: false

description: allow playing hdr formats if available.

update_favorites

type: bool

default value: false

description: update favorites info including thumbnail and video count when the playlist or channel is loaded.

save_history

type: bool

default value: false

description: save video watch history.