Skip to content

README.md

Latest commit

 

History

History
44 lines (28 loc) · 1.61 KB

README.md

File metadata and controls

44 lines (28 loc) · 1.61 KB
Raw

PlatynUI Wayland Compositor

The PlatynUI Wayland compositor is a controlled Linux desktop environment for UI automation tests. It can run nested during development or headless in CI, so tests do not depend on whatever desktop session happens to be open on the machine.

Use it when you need repeatable window placement, screen size, keyboard layout, screenshots, and input behavior for Linux automation work.

Run it

From the repository root:

cargo run -p platynui-wayland-compositor -- --backend winit

For headless CI-style runs:

cargo run -p platynui-wayland-compositor -- --backend headless --exit-with-child -- your-test-command

For X11 applications through XWayland:

cargo run -p platynui-wayland-compositor -- --backend winit --xwayland --print-env

Notes

  • winit is the easiest backend for local development because it opens a nested window.
  • headless is intended for automated test runs.
  • --print-env prints environment variables that child applications can use to connect to the compositor.
  • The companion control tool is documented in ../wayland-compositor-ctl/README.md.

More information

  • docs/ - current working notes for compositor usage, configuration, and the control protocol.
  • ../../dev-docs/ - project developer notes and planning material.
  • ../../README.md - project overview.

The files in docs/ (here) and ../../dev-docs/ are developer documentation for now and will be consolidated into user-facing docs later.

License

Apache-2.0. See the repository's LICENSE file.