Initial Commit

.gitignore

@@ -0,0 +1 @@
+/target

Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "grex_terminal_display"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+crossterm = "0.27.0"
+
+[dependencies.bevy]
+version = "0.13"
+features = ["dynamic_linking"]
+
+[dependencies.grex_framebuffer_extract]
+git = "https://github.com/exvacuum/grex_framebuffer_extract"
+tag = "v0.1.0"
+
+[dependencies.grex_dither_post_process]
+git = "https://github.com/exvacuum/grex_dither_post_process"
+tag = "v0.1.2"

LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Silas Bartha
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

LICENSE-MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Silas Bartha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,71 @@
+# grex_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:
+- `TerminalDisplayBundle` 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
+- Keyboard input enhancements using kitty protocol
+
+Future Goals:
+- Find a way to integrate into a TUI library like ratatui for more interaction options.
+- Move kitty enhancements to a feature maybe
+
+## Screenshots
+![](./doc/screenshot.png)
+## Compatibility
+
+| Crate Version | Bevy Version |
+|---            |---           |
+| 0.1           | 0.13         |
+
+## Installation
+
+### Using git URL in Cargo.toml
+```toml
+[dependencies.grex_terminal_display]
+git = "https://github.com/exvacuum/grex_terminal_display.git"
+```
+
+## Example Usage
+
+In `main.rs`:
+```rs
+use bevy::prelude::*;
+use grex_terminal_display;
+
+fn main() {
+    App::new()
+        .add_plugins((
+            DefaultPlugins.build().disable::<WinitPlugin>(),
+            ScheduleRunnerPlugin::run_loop(Duration::from_secs_f32(1.0 / 60.0)),
+            grex_terminal_display::TerminalDisplayPlugin,
+        ))
+        .insert_resource(Msaa::Off) // For post-process
+        .run();
+}
+```
+
+When spawning a camera:
+```rs
+let terminal_display_bundle = grex_terminal_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,
+));
+```
+
+
+

src/components.rs

@@ -0,0 +1,72 @@
+use bevy::{
+    prelude::*,
+    render::render_resource::{
+        Extent3d, TextureDescriptor, TextureDimension, TextureFormat, TextureUsages,
+    },
+};
+use grex_dither_post_process::components::DitherPostProcessSettings;
+use grex_framebuffer_extract::{
+    components::{ExtractFramebufferBundle, FramebufferExtractDestination},
+    render_assets::FramebufferExtractSource,
+};
+
+#[derive(Component)]
+pub struct TerminalDisplay;
+
+#[derive(Bundle)]
+pub struct TerminalDisplayBundle {
+    _terminal_display: TerminalDisplay,
+    extract_framebuffer_bundle: ExtractFramebufferBundle,
+    dither_post_process_settings: DitherPostProcessSettings,
+    image_handle: Handle<Image>,
+}
+
+impl TerminalDisplayBundle {
+    pub fn new(dither_level: u32, asset_server: &AssetServer) -> Self {
+        let terminal_size = crossterm::terminal::size().unwrap();
+        let size = Extent3d {
+            width: (terminal_size.0 as u32) * 2,
+            height: (terminal_size.1 as u32) * 4,
+            depth_or_array_layers: 1,
+        };
+
+        let mut image = Image {
+            texture_descriptor: TextureDescriptor {
+                label: None,
+                size,
+                dimension: TextureDimension::D2,
+                format: TextureFormat::R8Unorm,
+                mip_level_count: 1,
+                sample_count: 1,
+                usage: TextureUsages::TEXTURE_BINDING
+                    | TextureUsages::COPY_SRC
+                    | TextureUsages::RENDER_ATTACHMENT,
+                view_formats: &[],
+            },
+            ..default()
+        };
+
+        image.resize(size);
+        let image_handle = asset_server.add(image);
+
+        let framebuffer_extract_source =
+            asset_server.add(FramebufferExtractSource(image_handle.clone()));
+
+        Self {
+            _terminal_display: TerminalDisplay,
+            extract_framebuffer_bundle: ExtractFramebufferBundle {
+                source: framebuffer_extract_source,
+                dest: FramebufferExtractDestination::default(),
+            },
+            image_handle,
+            dither_post_process_settings: DitherPostProcessSettings::new(
+                dither_level,
+                asset_server,
+            ),
+        }
+    }
+
+    pub fn image_handle(&self) -> Handle<Image> {
+        self.image_handle.clone()
+    }
+}

src/events.rs

@@ -0,0 +1,5 @@
+use bevy::prelude::*;
+use crossterm::event::Event;
+
+#[derive(Event)]
+pub struct TerminalInputEvent(pub Event);

src/lib.rs

@@ -0,0 +1,43 @@
+use std::io::stdout;
+
+use bevy::prelude::*;
+use crossterm::{
+    event::PopKeyboardEnhancementFlags, terminal::disable_raw_mode, ExecutableCommand,
+};
+use grex_dither_post_process::DitherPostProcessPlugin;
+use grex_framebuffer_extract::FramebufferExtractPlugin;
+
+pub use crossterm::event::KeyCode;
+
+pub mod components;
+pub mod events;
+pub mod resources;
+mod systems;
+
+pub struct TerminalDisplayPlugin;
+
+impl Plugin for TerminalDisplayPlugin {
+    fn build(&self, app: &mut App) {
+        app.add_plugins((DitherPostProcessPlugin, FramebufferExtractPlugin))
+            .add_systems(Startup, systems::setup)
+            .add_systems(
+                Update,
+                (
+                    systems::input_handling,
+                    systems::resize_handling,
+                    systems::print_to_terminal,
+                ),
+            )
+            .insert_resource(resources::EventQueue::default())
+            .insert_resource(resources::TerminalInput::default())
+            .add_event::<events::TerminalInputEvent>();
+    }
+}
+
+impl Drop for TerminalDisplayPlugin {
+    fn drop(&mut self) {
+        let mut stdout = stdout();
+        stdout.execute(PopKeyboardEnhancementFlags).unwrap();
+        disable_raw_mode().unwrap();
+    }
+}

src/resources.rs

@@ -0,0 +1,38 @@
+use std::sync::{Arc, Mutex};
+
+use bevy::{prelude::*, utils::HashSet};
+use crossterm::event::{Event, KeyCode};
+
+#[derive(Resource, Default)]
+pub struct TerminalInput {
+    pressed_keys: HashSet<KeyCode>,
+    released_keys: HashSet<KeyCode>,
+}
+
+impl TerminalInput {
+    pub fn is_pressed(&self, code: KeyCode) -> bool {
+        self.pressed_keys.contains(&code)
+    }
+
+    pub fn is_released(&self, code: KeyCode) -> bool {
+        self.released_keys.contains(&code)
+    }
+
+    pub(super) fn press(&mut self, code: KeyCode) {
+        if !self.is_pressed(code) {
+            self.pressed_keys.insert(code);
+        }
+    }
+
+    pub(super) fn release(&mut self, code: KeyCode) {
+        if self.is_pressed(code) {
+            self.pressed_keys.remove(&code);
+        }
+        if !self.is_released(code) {
+            self.released_keys.insert(code);
+        }
+    }
+}
+
+#[derive(Resource, Default)]
+pub(super) struct EventQueue(pub(super) Arc<Mutex<Vec<Event>>>);

src/systems.rs

@@ -0,0 +1,154 @@
+use std::{
+    io::{stdout, Write},
+    usize,
+};
+
+use bevy::{
+    prelude::*,
+    render::render_resource::{Extent3d, TextureFormat},
+};
+use crossterm::{
+    cursor::{self, MoveTo},
+    event::{read, Event, KeyEventKind, KeyboardEnhancementFlags, PushKeyboardEnhancementFlags},
+    terminal::enable_raw_mode,
+    ExecutableCommand, QueueableCommand,
+};
+use grex_framebuffer_extract::{
+    components::FramebufferExtractDestination, render_assets::FramebufferExtractSource,
+};
+
+use crate::{
+    events::TerminalInputEvent,
+    resources::{EventQueue, TerminalInput},
+};
+
+const BRAILLE_CODE_MIN: u16 = 0x2800;
+const BRAILLE_CODE_MAX: u16 = 0x28FF;
+const BRAILLE_DOT_BIT_POSITIONS: [u8; 8] = [0, 1, 2, 6, 3, 4, 5, 7];
+
+pub fn setup(event_queue: Res<EventQueue>) {
+    let event_queue = event_queue.0.clone();
+    std::thread::spawn(move || {
+        loop {
+            // `read()` blocks until an `Event` is available
+            match read() {
+                Ok(event) => {
+                    event_queue.lock().unwrap().push(event);
+                }
+                Err(err) => {
+                    panic!("Error reading input events: {:?}", err);
+                }
+            }
+        }
+    });
+
+    let mut stdout = stdout();
+    enable_raw_mode().expect("Failed to put terminal into raw mode");
+    let _ = stdout.execute(PushKeyboardEnhancementFlags(
+        KeyboardEnhancementFlags::REPORT_EVENT_TYPES,
+    ));
+    let _ = stdout.execute(cursor::Hide);
+}
+
+pub fn print_to_terminal(image_exports: Query<&FramebufferExtractDestination>) {
+    for image_export in image_exports.iter() {
+        let mut image = image_export
+            .0
+            .lock()
+            .expect("Failed to get lock on output texture");
+        //TODO: Find a better way of preventing first frame
+        if image.size() == UVec2::ONE {
+            continue;
+        }
+        if image.texture_descriptor.format != TextureFormat::R8Unorm {
+            warn_once!("Extracted framebuffer texture is not R8Unorm format. Will attempt conversion, but consider changing your render texture's format.");
+            info_once!("{:?}", image);
+            match image.convert(TextureFormat::R8Unorm) {
+                Some(img) => *image = img,
+                None => error_once!(
+                    "Could not convert to R8Unorm texture format. Unexpected output may occur."
+                ),
+            };
+        }
+
+        let mut output_buffer = Vec::<char>::new();
+        let width = image.width();
+        let height = image.height();
+        let data = &image.data;
+        for character_y in (0..height).step_by(4) {
+            for character_x in (0..width).step_by(2) {
+                let mut mask: u8 = 0;
+                for offset_x in 0..2 {
+                    for offset_y in 0..4 {
+                        let x = character_x + offset_x;
+                        let y = character_y + offset_y;
+                        if x < width && y < height && data[(y * width + x) as usize] == 0xFF {
+                            mask |= 1
+                                << (BRAILLE_DOT_BIT_POSITIONS[(offset_x * 4 + offset_y) as usize]);
+                        }
+                    }
+                }
+                output_buffer.push(braille_char(mask));
+            }
+        }
+
+        let string = output_buffer.into_iter().collect::<String>();
+        let mut stdout = stdout();
+        stdout.queue(MoveTo(0, 0)).unwrap();
+        stdout.write_all(string.as_bytes()).unwrap();
+        stdout.flush().unwrap();
+    }
+}
+
+fn braille_char(mask: u8) -> char {
+    match char::from_u32((BRAILLE_CODE_MIN + mask as u16) as u32) {
+        Some(character) => {
+            if character as u16 > BRAILLE_CODE_MAX {
+                panic!("Number too big!")
+            }
+            character
+        }
+        None => panic!("Error converting character!"),
+    }
+}
+
+pub fn input_handling(
+    event_queue: Res<EventQueue>,
+    mut input: ResMut<TerminalInput>,
+    mut event_writer: EventWriter<TerminalInputEvent>,
+) {
+    let mut event_queue = event_queue.0.lock().unwrap();
+    while let Some(event) = event_queue.pop() {
+        if let Event::Key(event) = event {
+            match event.kind {
+                KeyEventKind::Press => {
+                    input.press(event.code);
+                }
+                KeyEventKind::Release => {
+                    input.release(event.code);
+                }
+                _ => (),
+            }
+        }
+        event_writer.send(TerminalInputEvent(event));
+    }
+}
+
+pub fn resize_handling(
+    mut images: ResMut<Assets<Image>>,
+    mut sources: ResMut<Assets<FramebufferExtractSource>>,
+    mut event_reader: EventReader<TerminalInputEvent>,
+) {
+    for event in event_reader.read() {
+        if let Event::Resize(w, h) = event.0 {
+            for source in sources.iter_mut() {
+                let image = images.get_mut(&source.1 .0).unwrap();
+                image.resize(Extent3d {
+                    width: w as u32 * 2,
+                    height: h as u32 * 4,
+                    depth_or_array_layers: 1,
+                });
+            }
+        }
+    }
+}