gold-silver-copper / egui_ratatui

A ratatui backend that is also an egui widget. Deploy on web with WASM or ship natively with bevy, macroquad, or eframe

egui_ratatui : egui widget + ratatui backend (WASM)

+

Discord: https://discord.gg/tDBPkdgApN https://discord.gg/tDBPkdgApN

See Bevy and Macroquad folders for game engine examples

Web Demo : https://gold-silver-copper.github.io/ (works best on firefox)

See also: https://ratatui.rs/ https://github.com/emilk/egui

RataguiBackend is the name of the backend/widget in code

cargo add egui_ratatui

git clone https://github.com/gold-silver-copper/egui_ratatui.git

cd egui_ratatui

cd bevy_example

cargo run

This repo provides the Ratagui Backend, which is also a Widget for egui. So you can have a whole ratatui terminal inside of egui. Also since egui is so WASM compatible, this means we can use this to compile ratatui to WASM !

If you would like more information about compiling to WASM please consult the relevant EGUI backend documentation:

Bevy: https://bevy-cheatbook.github.io/platforms/wasm.html

Macroquad: https://macroquad.rs/articles/wasm/

eframe: https://github.com/emilk/eframe_template

Previously this repo was called 'ratatatui_egui_wasm' and the crate was called 'ratframe' , I decided to rename it to egui_ratatui for clarity and discoverability , please see the PRE-RENAME branch for the last version of ratframe.

Warning: seems theres currently a weird bug with high DPI displays that can break the render a bit. This bug is also pushing me to remove the internal use of the Label widget for wrapping the text layout. Will do that soon enough.

egui_ratatui's Issues

Usage Tips

If I find ways that make using the library better, I will document them here. Later I will make a better source but this is it for now.

coexist with other controls in a window?

I wanted to use a textedit as a cli entry line, rather than deal with keyboard events and sending them to the terminal.

However the way egui_ratatui calculates the available size is based off the entire window ui; so if you add any additional controls to the window, then egui_ratatui continually resizes itself larger until it hits the edges of the screen.