#grid #ascii #user-interface #ui #terminal #2d-grid

grux

A library for drawing grid-based user interfaces using ASCII characters

2 unstable releases

0.2.0 Jan 5, 2023
0.1.0 Jan 4, 2023

#427 in Visualization

MIT license

30KB
409 lines

grux

A library for drawing grid-based user interfaces using ASCII characters.

Rust Checks Coverage Status Current Crates.io Version Docs License: MIT

// Provides a uniform interface for drawing to a 2D grid.
use grux::GridWriter;

// Create a 3x3 2D array.
// Alternatives provided by `grux`: `Vec<Vec<T>>` and `String`.
let mut grid = [[' '; 3]; 3];

// Draw some random stuff. In practice, you'd probably use the `Sprite` trait.
grid.set((0, 0), '');
grid.set((1, 0), '');
grid.set((2, 0), '');
grid.set((0, 1), '');
grid.set((2, 1), '');
grid.set((0, 2), '');
grid.set((1, 2), '');
grid.set((2, 2), '');

// Provides a uniform interface for displaying a 2D grid.
use grux::DisplayGrid;

// ╔═╗
// ║ ║
// ╚═╝
println!("{}", grid.to_string().unwrap());

See the examples directory for more, including built-in sprites.

Why Grux?

There are plenty of existing libraries for terminal-based user interfaces, but none of them are quite what I wanted. I wanted a library that would let me draw a grid of cells, each of which could contain a single character.

Importantly, Grux isn't a UI framework.

It doesn't handle input or even output. It just lets you draw to a grid-like structure, which could be:

  • A Vec<Vec<T>>
  • A String
  • A fixed-size 2D array (i.e. [[T; 10]; 10])
  • Your custom data structure (just implement GridWriter and/or DisplayGrid)

tl;dr: Draw to whatever you want, and build on top of it (or replace it).

No runtime deps