@@ -17,7 +17,7 @@ English | [简体中文](README_zh-CN.md)
1717- 📏 ** Adaptive Sizing** : Automatically scale images to fit terminal window
1818- ⌨️ ** Interactive Pause** : Optional pause after display for convenient viewing
1919- 🖥️ ** Multiple Display Modes** : Support for full-resolution and half-resolution display modes
20- - 🖥️ ** Multiple Terminal Protocol Support** : Support for WezTerm, Kitty, and iTerm2 image protocols
20+ - 🖥️ ** Multiple Terminal Protocol Support** : Support for WezTerm, Kitty, iTerm2 and Sixel image protocols
2121- 🎞️ ** GIF Animation Support** : Play GIF animations in terminal
2222- 🎥 ** Video Playback Support** : Play video files in terminal (requires ` video_player ` feature and FFmpeg)
2323- 🔊 ** Audio Support** : Add audio tracks to GIF animations
@@ -34,6 +34,7 @@ English | [简体中文](README_zh-CN.md)
3434| reqwest | reqwest | HTTP client library | <span style =" color : green " >✓</span > |
3535| gif_player | gif, rodio, crossbeam-channel | Play GIF animations in terminal | <span style =" color : green " >✓</span > |
3636| video_player | rodio, ez-ffmpeg, video-rs, crossbeam-channel, ** FFmpeg** | Play video files in terminal (requires video feature and FFmpeg) | <span style =" color : red " >✗</span > |
37+ | sixel_support| quantette, nohash-hasher | Display images using Sixel protocol | <span style =" color : green " >✓</span > |
3738
3839## Installation
3940
@@ -139,6 +140,12 @@ image_to_console --protocol kitty file image.jpg
139140
140141# Display image using iTerm2 image protocol
141142image_to_console --protocol iterm2 file image.jpg
143+
144+ # Display image using Sixel protocol
145+ image_to_console --protocol sixel file image.jpg
146+
147+ # Display image using Sixel protocol with custom max colors
148+ image_to_console --protocol sixel --max-colors 128 file image.jpg
142149```
143150
144151### File Subcommand Options
@@ -200,6 +207,8 @@ image_to_console video --audio path/to/audio.mp3 path/to/video.mp4
200207- ** WezTerm mode** (--protocol wezterm): Use WezTerm's inline image protocol to display original image directly
201208- ** Kitty mode** (--protocol kitty): Use Kitty's inline image protocol to display original image directly
202209- ** iTerm2 mode** (--protocol iterm2): Use iTerm2's inline image protocol to display original image directly
210+ - ** Sixel mode** (--protocol sixel): Use Sixel protocol to display images in supported terminals
211+ - ** Full-resolution Sixel mode** (--protocol sixel --full-resolution): Use Sixel protocol to display images in supported terminals with full resolution
203212
204213### Grayscale Modes
205214- ** Grayscale mode** (--no-color): Convert image to grayscale character art display
@@ -238,6 +247,8 @@ Supports most common image formats, including but not limited to:
238247| [ ez-ffmpeg] ( https://crates.io/crates/ez-ffmpeg ) | 0.5.3 | MIT | Video processing (optional) |
239248| [ video-rs] ( https://crates.io/crates/video-rs ) | 0.10.3 | MIT | Video processing (optional) |
240249| [ ndarray] ( https://crates.io/crates/ndarray ) | 0.16.1 | MIT | N-dimensional array (optional) |
250+ | [ quantette] ( https://crates.io/crates/quantette ) | 0.3.0 | MIT | Sixel image quantization (optional) |
251+ | [ nohash-hasher] ( https://crates.io/crates/nohash-hasher ) | 0.2.0 | MIT | Sixel Fast Hash (Optional) |
241252
242253## License
243254
0 commit comments