73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
# bevy_terminal_display
|
|
|
|
[](https://crates.io/crates/bevy_terminal_display)
|
|
|
|
|
|
A (very experimental) plugin for the [Bevy](https://bevyengine.org) engine which allows for rendering to a terminal window.
|
|
|
|
WARNING: I highly recommend using the kitty terminal emulator with this, not only due to the gpu-accelerated rendering, but also the implementation of the kitty protocol which enables the advanced input detection.
|
|
|
|
Features Include:
|
|
- `TerminalDisplay` automatically sets up a correctly-formatted render texture
|
|
- Post-process dithers colors to pure black and white, which are then printed as braille characters to the terminal
|
|
- Responsiveness to terminal window resizing
|
|
- `TerminalInput` resource which keeps track of pressed & released keys
|
|
- `Widget` component for rendering ratatui TUI widgets
|
|
- `TerminalWidget` trait for creating custom TUI widget components
|
|
- Log redirection
|
|
|
|
## Screenshots
|
|
|
|
## Compatibility
|
|
|
|
| Crate Version | Bevy Version |
|
|
| ------------- | ------------ |
|
|
| 0.6-0.7 | 0.15 |
|
|
| 0.4 | 0.14 |
|
|
| 0.2 | 0.13 |
|
|
|
|
## Installation
|
|
|
|
### crates.io
|
|
```toml
|
|
[dependencies]
|
|
bevy_terminal_display = "0.7"
|
|
```
|
|
|
|
### Using git URL in Cargo.toml
|
|
```toml
|
|
[dependencies.bevy_terminal_display]
|
|
git = "https://git.soaos.dev/soaos/bevy_terminal_display"
|
|
```
|
|
|
|
## Example Usage
|
|
|
|
In `main.rs`:
|
|
```rs
|
|
use bevy::prelude::*;
|
|
use bevy_terminal_display;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins((
|
|
DefaultPlugins.build().disable::<WinitPlugin>().disable::<LogPlugin>,
|
|
ScheduleRunnerPlugin::run_loop(Duration::from_secs_f32(1.0 / 60.0)),
|
|
bevy_terminal_display::TerminalDisplayPlugin::default(),
|
|
))
|
|
.run();
|
|
}
|
|
```
|
|
|
|
When spawning a camera:
|
|
```rs
|
|
commands.spawn((
|
|
// Camera3d...
|
|
TerminalDisplay(3), // Field is level of dithering
|
|
));
|
|
```
|
|
|
|
## License
|
|
|
|
This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license.
|
|
|