Cursive Image

An image view for the Cursive TUI library.

Works on terminals that support the Kitty graphics protocol, including:

• Ghostty
• iTerm2
• Kitty (duh!)
• Konsole
• Warp
• Wayst
• WezTerm
• xterm.js

The view supports shrink (the default), fit, and scale sizing modes, image alignment, and scrolling.

You can provide image data directly as RGB (24 bits per pixel), RGBA (32 bits per pixel), or from the following source formats:

• PNG (natively supported by the graphics protocol; enable png feature for some extra functionality)
• GIF (enable gif feature; internally relies on gif)
• JPEG (enable jpeg feature; internally relies on zune-jpeg)
• SVG (enable svg feature; internally relies on resvg)
• PDF (enable pdf feature; internally relies on hayro)

Supports both standard (sprite) and placeholder modes.

It also automatically uses tmux passthrough mode if it detects that it's in a tmux session. However, note that this feature is not enabled by default in tmux. To enable it from the terminal:

tmux set -g allow-passthrough on

Or add this to ~/.tmux.conf:

set -g allow-passthrough on

Check out the examples.

License

Like much of the Rust ecosystem this project is licensed under your choice of either

• Apache License, Version 2.0
• MIT license

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

All code and documentation was written by humans. We do not accept "AI"-generated contributions.