A Ratatui widget to turn any image to a splash screen in your terminal ✨
See the demo of gpg-tui for a real world example.
- Turn any image (
jpg,png) into a splash screen! - Verifies the file integrity via checking SHA checksum (optional)
- Supports grayscaling
cargo add ratatui ratatui-splash-screen
Create a SplashConfig and construct a SplashScreen widget with it. Then render the widget in a loop using the render function. You can check if the splash screen is done rendering by calling is_rendered.
use std::error::Error;
use std::io::stdout;
use std::time::Duration;
use ratatui::prelude::*;
use ratatui_splash_screen::{SplashConfig, SplashScreen, SplashError};
static SPLASH_CONFIG: SplashConfig = SplashConfig {
image_data: include_bytes!("../assets/splash.png"),
sha256sum: Some("c692ae1f9bd4a03cb6fc74a71cb585a8d70c2eacda8ec95e26aa0d6a0670cffd"),
render_steps: 12,
use_colors: true,
};
fn main() -> Result<(), Box<dyn Error>> {
// create a terminal
let backend = CrosstermBackend::new(stdout());
let mut terminal = Terminal::new(backend)?;
// render splash screen
let mut splash_screen = SplashScreen::new(SPLASH_CONFIG)?;
while !splash_screen.is_rendered() {
terminal.draw(|frame| {
frame.render_widget(&mut splash_screen, frame.size());
})?;
std::thread::sleep(Duration::from_millis(100));
}
Ok(())
}
See the full example here.
- Use small images (such as 200x200) for a better experience.
- You can tweak the
render_stepsvalue for smoother rendering. - Run
sha256sum(1)command on your system to find out the SHA value. You can set it toNoneif you don't want to check integrity.
See the contribution guidelines.
Licensed under either of Apache License Version 2.0 or The MIT License at your option.
🦀 ノ( º _ º ノ) - respect crables!
Copyright © 2024, Orhun Parmaksız
13 Jun 14, 2023
4 Dec 19, 2023
226 Jul 26, 2024
6 Dec 18, 2022
7 Dec 28, 2022
46 May 6, 2023
11 Jun 15, 2023
255 Dec 20, 2022
2.1k Jan 3, 2023
16 Mar 10, 2024
123 Nov 20, 2022
7 Sep 7, 2023
1.2k Dec 19, 2022
13 Nov 28, 2022
5 Feb 29, 2024
28 Mar 11, 2024
23 Dec 30, 2022
4 Feb 27, 2024
3 Nov 30, 2022