Skip to content

crates-lurey-io/retroglyph

Repository files navigation

retroglyph

2D pseudographic terminal.

Test Crates.io Version codecov

Retroglyph is a code-page 437 terminal renderer and lightweight UI framework, similar to BearLibTerminal.

This project is under heavy development and is not yet ready for use.

Features

Currently retroglyph has no required dependencies, and supports no_std1.

backend-software

Enables the software backend.

Uses softbuffer to render a terminal as a &mut [u32] pixel buffer.

Comparison

The following is a comparison of features with BearLibTerminal:

Initialization and configuration:

  • open
  • close
  • set

Output state:

  • color
  • bkcolor
  • composition
  • layer

Output:

  • clear
  • clear_area
  • crop
  • refresh
  • put
  • pick
  • pick_color
  • pick_bkcolor
  • put_ext
  • print
  • measure

Input:

  • state
  • check
  • has_input
  • read
  • peek
  • read_str

Utility:

  • delay
  • color_from_name
  • color_from_argb

Contributing

This project uses just to run commands the same way as the CI:

  • cargo just check to check formatting and lints.
  • cargo just coverage to generate and preview code coverage.
  • cargo just doc to generate and preview docs.
  • cargo just test to run tests.

For a full list of commands, see the Justfile.

Footnotes

  1. I have delusions of using this on a microcontroller.

About

2D pseudographic terminal

Topics

Resources

License

Stars

Watchers

Forks