ukiyoe

KO | EN

gitlite — search

#hacktoberfest #react #android #machine-learning #rust #linux #docker #nodejs #windows #awesome #cli #vue #awesome-list #mcp

(★ 28)

A Rust library for rendering images to terminals

ukiyoe Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ukiyoe

Render images to the terminal using truecolor and unicode.

This package was meant to be used by it's sister package [kimono](https://github.com/richardanaya/kimono).

```terminal
cargo add ukiyoe
```

# Examples

*Render to terminal with width and height.*

```rust
use ukiyoe::Image;

fn main() {
    let mut image = Image::new("examples/test.png");
    image.render(100, 40);
}
```

*Render at a specific location.*

```rust
use ukiyoe::Image;

fn main() {
    let mut image = Image::new("examples/test.png");
    image.render_at_position(0, 0, 100, 40);
}
```

*Render raw pixels.*

```rust
use ukiyoe::Image;

fn main() {
    Image::render_pixels(
        20,
        20,
        &[
            [255, 0, 0, 255],
            [0, 255, 0, 255],
            [0, 0, 255, 255],
            [0, 0, 255, 255],
        ],
        2,
    );
}
```

# Art

![ukiyoe_portland](https://user-images.githubusercontent.com/294042/181436102-fdef0292-2170-4b5f-9779-de3c4a22ce4c.png)

# License

This project is licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
   http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license ([LICENSE-MIT](LICENSE-MIT) or
   http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in `ukiyoe` by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

ukiyoe

ukiyoe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

ukiyoe

ukiyoe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README