ikachan config reference

the following lists the keys and descriptions for ikachan.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: 100

description: the thumbnail height.

thumb_mode

type: string

default value: "normal"

description: the thumbnail mode:

• normal - scaled to fit
• filled - scaled to fill
• filled_vtop - scaled to fill, top gravity
• rowpack - scaled to same height, tightly packed in rows

save_path

type: string

default value: "."

description: the path to save full size images.

thumbnail_save_path

type: string

default value: "."

description: the path to save thumbnail images.

metadata_save_path

type: string

default value: "."

description: the path to save metadata.

infinite_scroll

type: bool

default value: false

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

check_if_exists

type: bool

default value: false

description: do not overwrite when saving images if the image already exists.

use_high_quality_scaler

type: bool

default value: true

description: use slower, high quality scaler for viewing full size images instead of faster, low quality bilinear scaler.

save_on_loaded

type: string

description: save the image when the full size image is loaded:

• all - save the image when the full size image is loaded

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

site

type: string

default value: "gelbooru"

description: the default booru to use: can be one of gelbooru, danbooru, safebooru, sankaku, konachan, yandere, tbib

note:

• features requiring accounts are currently not supported: on danbooru and sankaku, tag limits apply, and posts with restricted tags are not displayed; on sankaku, only the first 10 tags are available in post metadata.
• as an alternative to danbooru, add user:danbooru to tag query on gelbooru. this limits search results to posts scraped from danbooru only.

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, refresh, append, save_current_image, hide_info, show_info, add_favorites, prev_page, next_page, set_dark_theme, set_light_theme, set_yuuka_theme, set_custom_theme, inc_info_size, dec_info_size, inc_list_size, dec_list_size, search_autocomplete, exit_autocomplete, clear_thumbnail_cache, make_index, switch_metadata_mode, page_up, page_down, prev_image, next_image, focus_search_input, open_external_viewer, toggle_zoom_mode, toggle_image_bar
• 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"}
]

smooth_scroll

type: bool

default value: false

description: enable smooth scrolling.

draw_thumb_shadow

type: bool

default value: true

description: draw shadow under thumbnails.

save_window_position

type: bool

default value: false

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

metadata_mode

type: string

default value: "hybrid"

description: the metadata mode used for local searching. version 1.20230919 adds the ability to use an index file for faster searching, which is generated by the make_index action from ikachan-local.

• individual - do not use the index file. slowest option that matches the behavior of previous versions and provides the most accurate results.
• index - only use the index file. fastest option, but newly saved images since the last update of the index file are not searchable.
• hybrid - use the index file, and use the individual metadata files that are newer than the index file. newly saved images are searchable, but they may contain duplicates for overwritten metadata files.

external_viewer_path

type: string

description: the path to run the external viewer.

save_history

type: bool

default value: false

description: save search history which is loaded on next startup.

show_post_view_bar

type: bool

default value: false

description: show the image bar on startup.

load_last_search

type: bool

default value: false

description: load last search on startup. save_history option must be enabled.

autoload_first_image

type: bool

default value: false

description: autoload the first image after searching.

api_keys

type: object

description: set the api keys for search requests for the sites, which can be used to bypass search restrictions.

the object has keys of the site names and values of the api key url parameters to append.

the following is a sample config for gelbooru and danbooru api keys, replace the placeholder values with your api keys:

"api_keys": {
  "gelbooru": "&api_key=your_api_key&user_id=your_user_id",
  "danbooru": "&login=your_username&api_key=your_api_key"
}