FAQs
- Why?
Why not?
To improve and extend the capabilities of CLI and TUI applications.
Terminals emulators have always been and always will be!
- What about Windows support?
Firstly, only the new Windows Terminal seems to have proper ANSI support and mordern terminal emulator features.
The library and the viewer’s CLI mode currently work (with a few quirks) on Windows (i.e using
cmd
orpowershell
) if the other requirements are satisfied but can’t guarantee it’ll always be so.Drawing images and animations doesn’t work completely well in
cmd
andpowershell
. See Known Issues.
The TUI doesn’t work due to the lack of fcntl on Windows, which is used by urwid.
If stuck on Windows and want to use all features, you could use WSL + Windows Terminal.
- Why are colours not properly reproduced?
Some terminals support 24-bit colors but have a 256-color pallete. This limits color reproduction.
- Why are images out of scale?
If Auto Font Ratio is supported and enabled,
For the library, set
SWAP_WIN_SIZE
toTrue
.For the CLI or TUI, use the swap win size config option or the
--swap-win-size
command-line option.If any of the above doesn’t work, then open a new issue here with adequate details.
Otherwise,
For the library, adjust the font ratio using
set_font_ratio()
.For the CLI or TUI, adjust the font ratio using the config option or the
-F | --font-ratio
command-line option.
- Why is the TUI unresponsive or slow in drawing images?
Drawing (not rendering) speed is entirely dependent on the terminal emulator itself.
Some terminal emulators block upon input, so rapidly repeated input could cause the terminal to be unresponsive.