{"id":13598546,"url":"https://github.com/joshka/bevy_ratatui","last_synced_at":"2025-03-14T10:07:45.187Z","repository":{"id":241748553,"uuid":"807558242","full_name":"joshka/bevy_ratatui","owner":"joshka","description":"A rust crate to use Ratatui in a Bevy App","archived":false,"fork":false,"pushed_at":"2025-03-03T19:35:08.000Z","size":193,"stargazers_count":48,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-04T00:29:36.373Z","etag":null,"topics":["bevy","ratatui","rust","tui"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/bevy_ratatui","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshka.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-29T10:31:07.000Z","updated_at":"2025-02-27T14:02:42.000Z","dependencies_parsed_at":"2024-08-06T02:30:32.636Z","dependency_job_id":"1d2517fa-bbad-428c-bc45-1f5b196d4b35","html_url":"https://github.com/joshka/bevy_ratatui","commit_stats":{"total_commits":38,"total_committers":5,"mean_commits":7.6,"dds":0.4736842105263158,"last_synced_commit":"e8e3f3be6c432dc5368c4b72b8adefa681a65045"},"previous_names":["joshka/bevy_ratatui"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Fbevy_ratatui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Fbevy_ratatui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Fbevy_ratatui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshka%2Fbevy_ratatui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshka","download_url":"https://codeload.github.com/joshka/bevy_ratatui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243558479,"owners_count":20310573,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bevy","ratatui","rust","tui"],"created_at":"2024-08-01T17:00:53.545Z","updated_at":"2025-03-14T10:07:45.161Z","avatar_url":"https://github.com/joshka.png","language":"Rust","funding_links":[],"categories":["📦 Libraries"],"sub_categories":["🔧 Utilities"],"readme":"# Bevy_ratatui\n\nAn experiment using Ratatui from within a Bevy app. Note that this library is explicitly unstable\nand will break compatibility between 0.x versions.\n\nThe goal of this (at least to start) is not to do any rendering / 3D / etc. in the terminal, but\njust to see how useful it is to use the bevy concepts for apps. This may change over time.\n\n## Example app\n\nThis app demonstrates:\n\n- Using the `RatatuiContext` resource to draw widgets to the terminal\n- ScheduleRunnerPlugin to run the app loop\n- Using `Event`s to communicate\n- Handling `State`s to add logic that runs on transition (e.g. changing the background color when\n  going from Negative to Positive in a simple counter app)\n\n```shell\ncargo run --example demo\n```\n\nKeys:\n\n- Left / Right - modify the counter (look at what happens when you go negative)\n- Q / Esc - quit\n- P - simulate a panic (tests the color_eyre panic hooks)\n\n![Made with VHS](https://vhs.charm.sh/vhs-2g0S6RgGGQHseTCNItEQhg.gif)\n\n## Compatible Bevy versions\n\n| bevy  | bevy_ratatui |\n|-------|--------------|\n| 0.15  | 0.7          |\n| 0.14  | 0.6          |\n| 0.13  | 0.5          |\n\n## Ideas on progressing this\n\n- [ ] Rewrite Ratatui's `Terminal` as a Bevy SubApp. It's possible that this would allow rendering\n      to happen while the main app is continuing to run\n- [ ] Consider how to handle layout. Bevy has a lot of code related to this which might be possible\n      to incorporate\n- [ ] Convert Crossterm events into the bevy standard\n- [ ] Collab with the other bevy/crossterm/ratatui libs\n  - \u003chttps://github.com/cxreiff/bevy_rat\u003e - seems like the most recent / up to date crate with some\n    fairly similar ideas. Has some stuff for rendering images to the screen (e.g. spinning 3D cube).\n  - \u003chttps://github.com/octotep/bevy_crossterm\u003e - Crossterm plugin for the bevy game engine\n  - \u003chttps://github.com/TheEmeraldBee/widgetui\u003e - A bevy systems like widget system for ratatui and\n    crossterm. This is a bevy-like approach (not actual bevy) and has some neat ideas about Widgets\n  - \u003chttps://github.com/AlephAlpha/roguelike-bevy-crossterm\u003e - takes the approach of defining a\n    custom runner to handle the event loop to make a roguelike game\n  - \u003chttps://github.com/Mimea005/bevyterm\u003e - A bevy renderer for the terminal using crossterm that\n    does not use a custom runner like bevy_crossterm.\n  - \u003chttps://github.com/gold-silver-copper/bevy_ratatui\u003e - is sort of the opposite of this idea. It\n    runs a Ratatui app using bevy as the backend to draw to a graphical window / webpage target\n  - \u003chttps://github.com/gold-silver-copper/ratatui_egui_wasm\u003e - continuation of the previous with a\n    egui backend to render ratatui apps to the web\n  - \u003chttps://github.com/sstelfox/bevy_tui\u003e - tui-rs / bevy seems dead (last commit Jan 2023)\n\n## Previous bevy_ratatui crate\n\nPreviously there was another crate using this name which has since migrated to\n[ratatui_egui_wasm](https://github.com/gold-silver-copper/ratatui_egui_wasm).  A ratatui backend\nthat is also an egui widget. Deploy on web with WASM or ship natively with bevy, macroquad, or\neframe. Demo at \u003chttps://gold-silver-copper.github.io/\u003e\n\n## License\n\nCopyright (c) Josh McKinney\n\nThis project is licensed under either of\n\n- Apache License, Version 2.0\n   ([LICENSE-APACHE](LICENSE-APACHE) or \u003chttp://www.apache.org/licenses/LICENSE-2.0\u003e)\n- MIT license\n   ([LICENSE-MIT](LICENSE-MIT) or \u003chttp://opensource.org/licenses/MIT\u003e)\n\nat your option.\n\n## Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as above, without any additional terms or conditions.\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshka%2Fbevy_ratatui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshka%2Fbevy_ratatui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshka%2Fbevy_ratatui/lists"}