1# llimphi
2
3> Native UI framework: HAL · raster · layout · text · theme · ui — plus widgets and modules.
4
5`llimphi` is a sovereign, retained-mode UI framework with an Elm-style loop (`input → update → view → layout → raster → present`). Declarative pipeline over `vello` + `wgpu` + `taffy` + `parley`, with `Dark/Light/Aurora/Sunset` themes and a multi-platform HAL (Wayland · X11 · Win32 · Android · Wawa bare-metal). It powers a full Rust application suite; this repository is the framework extracted to stand on its own.
6
7<p align="center">
8  <img src="docs/showreel.gif" alt="Llimphi showreel — real widgets (switch, slider, progress, segmented control, buttons, radial) animating live, then reflowing across layouts" width="900">
9  <br>
10  <sub>real widgets in motion — rendered headless, frame-by-frame, fully deterministic</sub>
11</p>
12
13<p align="center">
14  <img src="docs/counter.gif" alt="counter example — the full Elm loop in ~124 LOC" width="480">
15  <br>
16  <sub>…and the entire Elm loop in ~124 LOC — <code>cargo run -p llimphi-ui --example counter</code></sub>
17</p>
18
19**Usage manual:** [MANUAL.md](MANUAL.md) — full reference (Elm loop, `View<Msg>` DSL, the ~44 widgets and 10 modules, GPU path, gotchas) for humans and AI. Design rationale and roadmap: [SDD.md](SDD.md).
20
21Philosophy: **widgets aren't designed against mockups; they're designed with what `vello` and `taffy` can do.**
22
23## Quick start
24
25```sh
26git clone https://git.tawasuyu.net/tawasuyu/llimphi.git
27cd llimphi
28cargo run -p llimphi-ui --example counter   # ~124 LOC: the full Elm loop on screen
29```
30
31## Install
32
33```toml
34[dependencies]
35llimphi-ui    = { git = "https://git.tawasuyu.net/tawasuyu/llimphi.git" }
36llimphi-theme = { git = "https://git.tawasuyu.net/tawasuyu/llimphi.git" }
37# widgets are one crate each — pull only what you use:
38llimphi-widget-button = { git = "https://git.tawasuyu.net/tawasuyu/llimphi.git" }
39```
40
41## Compatibility
42
43- **Linux/Wayland** — primary backend.
44- **Linux/X11** — via XWayland.
45- **macOS / Windows** — `winit` + `wgpu`.
46- **Android** — HAL via `android` crates.
47- **Wawa bare-metal** — alternative framebuffer HAL.
48
49Crates listed in [README.md](README.md) (framework, widgets, modules, android).
50
51## Considerations
52
53- **Single API: declarative `View<Msg>`.** No imperative, no foreign vDOM.
54- **Same scene tree on Wayland and Wawa**: HAL abstracts the surface.
55- Widgets are **purely visual**; modules encapsulate state + behavior.