vornix-banner

Crates.iovornix-banner
lib.rsvornix-banner
version0.0.1
created_at2025-04-18 21:37:05.613861+00
updated_at2025-04-18 21:39:22.676562+00
descriptionGenera y muestra banners de texto ASCII estilo FIGlet profesionales en la terminal, con colores, fuentes personalizables.
homepage
repositoryhttps://github.com/AngelEspinal1/vornix-banner.git
max_upload_size
id1639878
size207,194
Vornix (AngelEspinal1)

documentation

https://docs.rs/vornix-banner

README

Vornix Banner 馃

Vornix Banner Logo

Una librer铆a de Rust para generar y mostrar banners de texto ASCII estilo FIGlet en la terminal, con colores, fuentes personalizables y animaci贸n opcional.

Descripci贸n

Vornix Banner es parte de la iniciativa Vornix para traer herramientas robustas y eficientes al ecosistema Rust, inspirados por nuestra experiencia en el mundo Java. Esta librer铆a facilita la creaci贸n de banners llamativos para tus aplicaciones de consola, similar a lo visto en frameworks como Spring Boot, pero con la potencia y seguridad de Rust.

Caracter铆sticas Clave

  • Generaci贸n FIGlet: Convierte texto a arte ASCII.
  • Fuentes Flexibles: Usa fuentes est谩ndar incrustadas o carga archivos .flf externos.
  • Estilos Avanzados: Colores RGB y atributos (negrita, it谩lica, etc.).
  • Presets de Configuraci贸n: M茅todos r谩pidos para banners comunes (Default, Warning, Success).
  • Animaci贸n: Soporte para animaciones frame-a-frame manuales.
  • Layout: Opciones de centrado y padding.
  • Renderizado Robusto: Limpieza y restauraci贸n en caso de panic.
  • Unicode & ANSI: C谩lculo correcto del ancho de caracteres.

Instalaci贸n

A帽ade vornix-banner a tu Cargo.toml:

[dependencies]
vornix-banner = { version = "0.0.1", features = ["presets"] }

Ejemplo de uso

Copia el siguiente c贸digo en tu main.rs para probar la librer铆a:

use vornix_banner::{Banner, BuiltinFont, Style, rgb, RUST_ORANGE};
use std::io;
use std::thread;
use std::time::Duration;

fn main() -> io::Result<()> {
    let mut banner_default = Banner::new("Vornix Rust 3D").bold();
    banner_default.display()?;

    thread::sleep(Duration::from_secs(1));

    let mut banner_custom = Banner::new("Vornix Rust 3D")
        .with_builtin_font(BuiltinFont::Larry3d)
        .with_style(
            Style::new()
                .fg(RUST_ORANGE)
                .bg(rgb(30, 30, 30))
                .bold()
        )
        .centered(true)
        .padding_top(2);

    banner_custom.display()?;

    Ok(())
}

Ejecutar el ejemplo

cargo run --example main --features presets

Vista previa del resultado

Ejemplo de salida del banner en terminal

Fuentes integradas

La librer铆a incluye las siguientes fuentes builtin:

  • Standard: fuente cl谩sica FIGlet.
  • Slant: fuente inclinada.
  • Small: versi贸n compacta y ligera.
  • Block: estilo bloque s贸lido.
  • Larry3d: aspecto tridimensional.
  • Lean: dise帽o estrecho.

Para usar una de estas fuentes, llama a:

Banner::new("Tu texto").with_builtin_font(BuiltinFont::Larry3d);

Contribuir

  1. Haz un fork del repositorio.
  2. Crea una rama (git checkout -b feature/nueva-funcionalidad).
  3. Haz tus cambios y tests.
  4. Env铆a un pull request.

隆Gracias por contribuir a Vornix Banner!

Commit count: 0

cargo fmt