A Wayland kiosk
Find a file
Jente Hidskes b0bd4e680d view: add view_has_children to query if a view has children
This allows us to check per-view whether is has dialogs open, instead of
diong it on a global basis as we are doing currently. This is necessary
for fully supporting multiple primary clients.
2019-01-12 19:27:24 +01:00
cage.c Add idle inhibitor support 2019-01-09 20:05:09 +01:00
config.h.in Add missing config.h.in 2019-01-02 22:28:56 +01:00
idle_inhibit_v1.c Add idle inhibitor support 2019-01-09 20:05:09 +01:00
idle_inhibit_v1.h Add idle inhibitor support 2019-01-09 20:05:09 +01:00
LICENSE Update copyright to include 2019 2019-01-02 21:01:01 +01:00
meson.build Add idle inhibitor support 2019-01-09 20:05:09 +01:00
meson_options.txt Add XWayland support 2019-01-02 20:58:48 +01:00
output.c Implement support for drag 'n drop icons 2019-01-11 15:28:09 +01:00
output.h output: handle size changes 2019-01-10 15:50:31 +01:00
README.md Add XWayland note to README 2019-01-04 18:49:48 +01:00
seat.c Implement support for drag 'n drop icons 2019-01-11 15:28:09 +01:00
seat.h Implement support for drag 'n drop icons 2019-01-11 15:28:09 +01:00
server.h Add idle inhibitor support 2019-01-09 20:05:09 +01:00
view.c view: add view_has_children to query if a view has children 2019-01-12 19:27:24 +01:00
view.h view: add view_has_children to query if a view has children 2019-01-12 19:27:24 +01:00
xdg_shell.c view: add view_has_children to query if a view has children 2019-01-12 19:27:24 +01:00
xdg_shell.h Use correct CG_ namespace in headers 2019-01-04 20:23:01 +01:00
xwayland.c view: add view_has_children to query if a view has children 2019-01-12 19:27:24 +01:00
xwayland.h Use correct CG_ namespace in headers 2019-01-04 20:23:01 +01:00

Cage: a Wayland kiosk

This is Cage, a Wayland kiosk. A kiosk runs a single, maximized application.

This README is only relevant for development resources and instructions. For a description of Cage and installation instructions for end-users, please see its project page.

Building and running Cage

You can build Cage with the meson build system. It requires wayland, wlroots and xkbcommon to be installed. Simply execute the following steps to build Cage:

$ meson build
$ ninja -C build

Cage comes with compile-time support for XWayland. To enable this, first make sure that your version of wlroots is compiled with this option. Then, add -Dxwayland=true to the meson command above. Note that you'll need to have the XWayland binary installed on your system for this to work.

You can run Cage by running ./build/cage APPLICATION. If you run it from within an existing X11 or Wayland session, it will open in a virtual output as a window in your existing session. If you run it at a TTY, it'll run with the KMS+DRM backend. In debug mode (default build type with Meson), press Alt+Esc to quit. To build a release build, use meson build --buildtype=release.

Cage is based on the annotated source of TinyWL.

Bugs

For any bug, please create an issue on GitHub.

License

Please see LICENSE on GitHub.

Copyright © 2018-2019 Jente Hidskes hjdskes@gmail.com