A terminal UI for Libby libbui.vinnymac.dev
libbui docs configuration.md
3.6 kB · 52 lines
Markdown
at main

Configuration #

libbui works without a configuration file. To create a commented one with every default spelled out, run libbui config init; libbui config path says where it is. A misspelt key or a wrong value is an error naming the file and line, never silently ignored.

Key Default Meaning
download_dir ~/Documents/Libby Where books are filed. ~/ is expanded.
theme "auto" auto, dark, light, ansi, high-contrast or mono. auto follows the terminal's background.
mouse true Capture the mouse for clicking and scrolling. false keeps the terminal's own text selection.
reduced_motion false No spinners or transitions; states are spelled out instead.
ascii false Draw with plain ASCII instead of box drawing and symbols.
screen_reader false Show the terminal cursor on the selected row, so screen readers and magnifiers follow the selection.
images "auto" Cover images: auto (the best your terminal supports), halfblocks or off.
default_library none Library key used for searching when you have several cards.
default_card none Card id or library key selected at startup and used by commands.
write_sidecars true Save cover.jpg and metadata.opf next to each book.
account_gap_ms 1000 Minimum pause between requests to your Libby account, in milliseconds. Values below 500 are rejected; lowering it is not recommended.
download_concurrency 2 Downloads at the same time (1 to 8).
[templates] ebook "Ebooks/{Author}/{Title}/{Title}" Where each book goes inside download_dir, without extension. Tokens: {Title} {Author} {Series} {SeriesIndex} {Year} {TitleId}; segments whose tokens are all empty are dropped.
[keymap] none Override keys by action name, for example quit = ["q", "ctrl-c"]. The help screen (?) lists the actions.

Themes and accessibility #

  • Never colour alone. Every state also has a symbol or a word (ready, suspended, failed), so libbui reads the same in any theme or with no colour at all.
  • NO_COLOR and --no-color are honoured by the interface (it switches to the mono theme) and by the command line.
  • high-contrast uses the strongest pairs your terminal offers; mono uses only bold, dim and reverse.
  • --ascii or ascii = true replaces box drawing, arrows and symbols with plain ASCII for limited fonts, screen readers and serial consoles.
  • reduced_motion = true turns off spinners and transitions.
  • screen_reader = true (also under Settings) shows the terminal cursor on the selected row of every list, menu and dialog. Screen readers and magnifiers that track the cursor, such as Orca, NVDA and macOS Zoom, then follow the selection. Otherwise the cursor appears only in text fields.
  • Dates, times and sizes are written the way the active language writes them; each translation's formats.ftl holds the month names, the clock and the decimal separator.
  • Text is measured in terminal cells, so CJK titles, emoji and long names line up and are shortened cleanly instead of overflowing.
  • Every word on screen comes from a translation catalogue (crates/libbui/locales); choose the language with --lang or LIBBUI_LANG. English is the only complete translation today. A language libbui has no catalogue for is refused with the list of those it has; only the system locale falls back to English quietly. An unknown --theme or theme is refused the same way.