ratatui-unity

ratatui-unity is a Rust native plugin that brings Ratatui's TUI ecosystem to Unity 3D game engine — for all platforms.

Try WebGL Demo on your browser: ratatui-unity-demo.farukcan.dev

Quick Links

• Getting Started — install the UPM package and render your first widget.
• Architecture — how the Rust core and Unity C# bridge fit together.
• Layout — Split, Constraint, Block, Inner, area IDs.
• Widget Examples — copy-pasteable snippets for every widget.
• Input Handling — keyboard, mouse, hover, TerminalInput, TerminalTextArea, TerminalCommandInput, mobile keyboard.
• Terminal Apps — scene-independent terminal apps: bootstrap, app list, open/close API.
• Samples Overview — what ships in Samples~/ and how each piece is wired.
  • BasicUsage tabs demo · Developer Console · Notepad · Profiler
• C# API Reference — public Unity-facing classes (RatatuiTerminal, RatatuiRenderer, builders).
• Rust API Reference — internal Rust crate, for contributors.
• Rust Contributor Guide — building native binaries, FFI conventions.

What it does

ratatui-unity lets you embed any Ratatui terminal UI inside a Unity scene as a Texture2D. Layout, widgets, styling, and input are driven by Ratatui in Rust; rasterization to RGB24 pixels happens natively; Unity sees a texture it can blit anywhere.

Supported Platforms

macOS · iOS · Windows · Linux · Android · WebGL