mirror of https://github.com/cage-kiosk/cage.git synced 2025-10-29 05:40:19 -04:00

A Wayland kiosk

Find a file

Jente Hidskes 21c01c9ee0 Add idle inhibitor support With this, some apps (e.g. mpv) can block the idle tracker from kicking in. This way, the screen won't blank (or whatever you configured) when the application doesn't want it to.		2019-01-09 20:05:09 +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	output: render an overlay when dialogs are open	2019-01-04 18:33:59 +01:00
output.h	Refactor cage into separate source files	2018-12-31 00:12:33 +01:00
README.md	Add XWayland note to README	2019-01-04 18:49:48 +01:00
seat.c	Add idle tracking	2019-01-09 20:05:09 +01:00
seat.h	output: render an overlay when dialogs are open	2019-01-04 18:33:59 +01:00
server.h	Add idle inhibitor support	2019-01-09 20:05:09 +01:00
view.c	view_destroy: focus the previous view when closing the current	2019-01-04 17:26:26 +01:00
view.h	view.h: conditionally include xwayland.h	2019-01-04 20:23:33 +01:00
xdg_shell.c	xdg_shell: only track toplevel xdg surfaces	2019-01-04 13:41:25 +01:00
xdg_shell.h	Use correct CG_ namespace in headers	2019-01-04 20:23:01 +01:00
xwayland.c	Seat: abstract away a view switch statement	2019-01-02 21:31:30 +01:00
xwayland.h	Use correct CG_ namespace in headers	2019-01-04 20:23:01 +01:00

README.md

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.