Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matanlurey/dt
Experimenting with terminal UIs in Dart
https://github.com/matanlurey/dt
Last synced: 8 days ago
JSON representation
Experimenting with terminal UIs in Dart
- Host: GitHub
- URL: https://github.com/matanlurey/dt
- Owner: matanlurey
- License: mit
- Created: 2024-05-20T01:07:11.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-18T07:20:07.000Z (5 months ago)
- Last Synced: 2024-06-18T18:59:02.245Z (5 months ago)
- Language: Dart
- Homepage: https://matanlurey.github.io/dt/
- Size: 771 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dart Terminal
A _fun_ and _minimalist_ experiment in crafting terminal UIs with Dart.
[](https://github.com/matanlurey/dt/actions/workflows/linux.yaml)
[](https://github.com/matanlurey/dt/actions/workflows/macos.yaml)
[](https://coveralls.io/github/matanlurey/dt?branch=main)
## Key Concepts
> [!NOTE]
>
> This project is a work-in-progress and everything is subject to change.
This project aims to provide an intuitive and ergonomic API for building,
emulating, and interacting with terminal applications in Dart. It's designed to
be a low-level building block for more complex terminal applications, such as
text editors, games, and interactive command-line interfaces.
### Buffer
A `Buffer` is a two-dimensional grid of characters with an associated style. It
is the primary building block for rendering text-based content to the terminal,
and it can be used to build more complex UI components. For example, a `Buffer`
can be used to render text, boxes, and sprites:
```dart
import 'package:dt/rendering.dart';
void main() {
final buffer = Buffer(10, 3, '#');
buffer.print(0, 1, 'Hello, World!');
// ##########
// Hello, Wor
// ##########
buffer.rows.forEach((row) => print(row.map((cell) => cell.symbol).join()));
}
```
### Surface
A `Surface` is a high-level abstraction for writing `Buffer`s to the terminal:
```dart
import 'package:dt/terminal.dart';
void main() {
final surface = Surface.fromStdout();
surface.draw((frame) {
frame.draw((buffer) {
buffer.print(0, 1, 'Hello, World!');
});
});
}
```
## Contributing
### CI/CD
This package is:
- Formatted with `dart format`.
- Checked with `dart analyze`.
- Tested with `dart test`, including with code coverage (see
[`tool/coverage.dart`](tool/coverage.dart)).
### Inspiration
This package is inspired by a number of libraries, including but not limited to:
- [crossterm](https://github.com/crossterm-rs/crossterm): A Rust library for
cross-platform terminal manipulation.
- [dart_console](https://github.com/timsneath/dart_console): A Dart library for
terminal manipulation.
- [fortress](https://pub.dev/packages/fortress): A Dart library for building
retro-style games.
- [hex_toolkit](https://pub.dev/packages/hex_toolkit): A Dart library for
hexagonal grids.
- [mini_sprite](https://pub.dev/packages/mini_sprite): A Dart library for
sprite-based rendering.
- [pathxp](https://pub.dev/packages/pathxp) and
[pathfinding](https://pub.dev/packages/pathfinding): Dart libraries for
pathfinding algorithms.
- [ratatui](https://crates.io/crates/ratatui): A Rust library for building
terminal UIs.
- [taffy](https://crates.io/crates/taffy): UI layout library for Rust.
- [termenv](https://github.com/muesli/termenv): A Go library for terminal
feature detection and styling.
- [termion](https://crates.io/crates/termion): A Rust library for low-level
bindless terminal manipulation.
- [termwiz](https://github.com/wez/wezterm/tree/main/termwiz): Another Rust
library for building a terminal emulator.
- [vaxis](https://sr.ht/~rockorager/vaxis/): A Rust library for building
terminal UIs.