#color #cli #terminal #graphics #block

hanbun

A library for drawing half blocks to the terminal

5 releases (3 breaking)

0.4.1 Mar 4, 2021
0.4.0 Mar 4, 2021
0.3.0 Feb 24, 2021
0.2.0 Feb 20, 2021
0.1.0 Feb 18, 2021

#112 in Command-line interface

47 downloads per month

MIT license

220KB
210 lines

Documentation Repository crates.io

半分

hanbun is a library for drawing half blocks ( and ) to the terminal, which allows rendering of various graphics.

Ferris

Ferris rendered using examples/image.rs

Installation

Add the following line to your Cargo.toml file:

hanbun = "0.4.1"

Examples

Here is an example that makes use of common features such as creating a buffer, setting colored half blocks, printing text and finally drawing the buffer to the screen.

use hanbun::{self, Color};

fn main() {
    // Let's draw these two kanji on the screen using half blocks!
    let lines = [
        " W   W   W      W W",
        "  W  W  W      W   W",
        "     W        W     W",
        " WWWWWWWWW   W       W",
        "     W      W         W",
        "     W       WWWWWWWWW",
        "WWWWWWWWWWW     W    W",
        "     W          W    W",
        "     W          W    W",
        "     W         W  W W",
        "     W       WW    W",
    ];

    let width = lines.iter().map(|line| line.len()).max().unwrap();
    let height = lines.len() / 2 + 2;
    // Here we store the state of each cell
    let mut buffer = hanbun::Buffer::new(width, height, ' ');

    let mut x = 0;
    let mut y = 0;
    for line in &lines {
        for char in line.chars() {
            // We set a colored half block for each W we find
            if char == 'W' {
                buffer.color(x, y, Color::Green);
            }
            x += 1;
        }
        y += 1;
        x = 0;
    }

    // Add some centered text to the bottom
    let text = "hanbun";
    buffer.print(width / 2 - text.len() / 2, height + 5, text);

    // Actually display what we've drawn
    buffer.draw();
}

The result:

Result

Results may vary depending on the terminal.

Make sure to check out the other examples too! You can run examples like the calculator right now:

git clone https://github.com/r00ster91/hanbun.git
cd hanbun
cargo run --example calculator

Footnotes

This is my first Rust library to make some crate development experience. As of now, the library is useable but if you do repeated drawing you might experience some tearing. On the bright side you get that nostalgic feeling of old displays.

Dependencies

~0.7–1MB
~20K SLoC