https://github.com/pierrechevalier83/matrix_display
A rust library to visualise pretty matrixes in cli
https://github.com/pierrechevalier83/matrix_display
cli matrix-display rust rust-library unicode
Last synced: over 1 year ago
JSON representation
A rust library to visualise pretty matrixes in cli
- Host: GitHub
- URL: https://github.com/pierrechevalier83/matrix_display
- Owner: pierrechevalier83
- Created: 2017-02-17T05:25:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-12T18:04:26.000Z (about 7 years ago)
- Last Synced: 2025-03-20T17:23:11.762Z (over 1 year ago)
- Topics: cli, matrix-display, rust, rust-library, unicode
- Language: Rust
- Size: 4.99 MB
- Stars: 16
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/pierrechevalier83/matrix_display)
[](https://coveralls.io/github/pierrechevalier83/matrix_display?branch=master)
Matrix Display
--------------
A simple rust library to visualize 2D matrixes in rust.
- Supports 256 terminal colours using AnsiTerm
- Multiple unicode box character sets supported (plain, retro, thin, rounded, thick, double)
Documentation
-------------
[Click here to access the documentation](https://pierrechevalier83.github.io/matrix_display/)
Build
-----
- `git clone git@github.com:pierrechevalier83/matrix_display.git`
- `cargo test`
Run
---
- `cargo run --example chess`
- `cargo run --example 2048`
- `cargo run --example palette`
Example: visualising a chess board
----------------------------------
```
extern crate matrix_display;
use matrix_display::*;
fn main() {
let format = Format::new(7, 3);
let board = vec!['♜', '♞', '♝', '♛', '♚', '♝', '♞', '♜',
'♟', '♟', '♟', '♟', '♟', '♟', '♟', '♟',
' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',
' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',
' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',
' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ',
'♖', '♘', '♗', '♕', '♔', '♗', '♘', '♖',
'♙', '♙', '♙', '♙', '♙', '♙', '♙', '♙']
.iter()
.enumerate()
.map(|(i, x)| {
let ansi_fg = 33;
let mut ansi_bg = 0;
if i % 2 + (i / 8) % 2 == 1 {
ansi_bg = 7;
}
cell::Cell::new(x.clone(), ansi_fg, ansi_bg)
})
.collect::>();
let data = matrix::Matrix::new(8, board);
let display = MatrixDisplay::new(format, data);
display.cell_at_cursor_position((13, 6)).color.bg = 10;
display.print(&mut std::io::stdout(), &style::BordersStyle::None);
}
```
For a working version of the game, see [chess-rs](https://github.com/pierrechevalier83/chess-rs)
Example: visualising a 2048 game
--------------------------------
```
extern crate matrix_display;
use matrix_display::*;
fn main() {
let format = Format::new(7, 3);
let colour_theme = vec![247, 78, 222, 220, 214, 208, 202, 196, 162, 160, 126, 90, 88, 54, 53, 52];
let board = (0..16)
.map(|x| {
cell::Cell::new(2_f64.powi(x + 1),
7,
*colour_theme.get(x as usize).unwrap() as u8)
})
.collect::>();
let data = matrix::Matrix::new(4, board);
let display = MatrixDisplay::new(format, data);
display.print(&mut std::io::stdout(), &style::BordersStyle::Thick);
}
```
For a working version of the game, see [2048-rs](https://github.com/pierrechevalier83/2048-rs)
Example: visualising a 256 colors palette
-----------------------------------------
```
extern crate matrix_display;
use matrix_display::*;
fn main() {
let format = Format::new(5, 1);
let board = (0..256)
.map(|x| cell::Cell::new(x, 0, x as u8))
.collect::>();
let data = matrix::Matrix::new(8, board);
let display = MatrixDisplay::new(format, data);
display.print(&mut std::io::stdout(), &style::BordersStyle::Thin);
```
For a self contained implementation, see [palette-rs](https://github.com/pierrechevalier83/palette-rs)
TODO
----
- Leverage fdehau/tui-rs to avoid redrawing the entire screen at every frame
- Should help with performance issues with [snake-rs](https://github.com/pierrechevalier83/snake-rs), my snake implementations.