aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Silas Bartha <[email protected]>2024-12-11 18:40:02 -0500
committerLibravatar Silas Bartha <[email protected]>2024-12-11 18:40:02 -0500
commit87172fd904a9d461b10438be7dc55660e7ced680 (patch)
tree99ef375d9ab628a7d2e22983fb7175a4f66720fb /README.md
parente1eb0d99f17e6604e79496db68b191202cb95d60 (diff)
Upgraded to Bevy 0.15HEADv0.5.0master
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 7 insertions, 16 deletions
diff --git a/README.md b/README.md
index 520e55b..dda51f8 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,6 @@
[![Crates](https://img.shields.io/crates/v/bevy_terminal_display)](https://crates.io/crates/bevy_terminal_display)
![License](https://img.shields.io/badge/license-0BSD%2FMIT%2FApache-blue.svg)
![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_terminal_display)
-![Build](https://img.shields.io/github/actions/workflow/status/exvacuum/bevy_terminal_display/rust.yml)
[![Docs](https://img.shields.io/website?url=https%3A%2F%2Fexvacuum.github.io%2Fbevy_terminal_display%2F&label=docs)](https://exvacuum.github.io/bevy_terminal_display)
A (very experimental) plugin for the [Bevy](https://bevyengine.org) engine which allows for rendering to a terminal window.
@@ -11,7 +10,7 @@ A (very experimental) plugin for the [Bevy](https://bevyengine.org) engine which
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:
-- `TerminalDisplayBundle` automatically sets up a correctly-formatted render texture
+- `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
@@ -20,11 +19,12 @@ Features Include:
- Log redirection
## Screenshots
-![](./doc/screenshot.png)
+![](https://git.exvacuum.dev/bevy_terminal_display/plain/doc/screenshot.png)
## Compatibility
| Crate Version | Bevy Version |
|--- |--- |
+| 0.5 | 0.15 |
| 0.3-0.4 | 0.14 |
| 0.2 | 0.13 |
@@ -33,13 +33,13 @@ Features Include:
### crates.io
```toml
[dependencies]
-bevy_terminal_display = "0.3"
+bevy_terminal_display = "0.5"
```
### Using git URL in Cargo.toml
```toml
[dependencies.bevy_terminal_display]
-git = "https://github.com/exvacuum/bevy_terminal_display.git"
+git = "https://git.exvacuum.dev/bevy_terminal_display"
```
## Example Usage
@@ -56,24 +56,15 @@ fn main() {
ScheduleRunnerPlugin::run_loop(Duration::from_secs_f32(1.0 / 60.0)),
bevy_terminal_display::TerminalDisplayPlugin::default(),
))
- .insert_resource(Msaa::Off) // For post-process
.run();
}
```
When spawning a camera:
```rs
-let terminal_display_bundle = bevy_terminal_display::display::components::TerminalDisplayBundle::new(3, &asset_server);
-
commands.spawn((
- Camera3dBundle {
- camera: Camera {
- target: terminal_display_bundle.image_handle().into(),
- ..Default::default()
- },
- ..Default::default()
- },
- terminal_display_bundle,
+ // Camera3d...
+ TerminalDisplay(3), // Field is level of dithering
));
```