diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 23 |
1 files changed, 7 insertions, 16 deletions
@@ -3,7 +3,6 @@ [](https://crates.io/crates/bevy_terminal_display)   - [](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 - + ## 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 )); ``` |