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

A Wayland kiosk

Find a file

Jonathan GUILLOT 6f78d9d5b2 cage: add basic wlr-output-management support Co-authored-by: Dima Krasner <dima@dimakrasner.com>		2023-07-28 15:36:34 +02:00
.github/workflows	CI: bump to wlroots 0.16	2022-12-17 21:56:03 +01:00
contrib	Include release scripts	2021-04-16 14:34:57 +02:00
.clang-format	Add clang-format file	2020-02-18 21:20:23 +01:00
.clang-format-ignore	Move to GitHub actions	2021-12-19 11:12:19 +01:00
cage.1.scd	cage: remove support for rotating outputs	2023-07-28 15:36:34 +02:00
cage.c	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
config.h.in	cage: add -v argument to print version	2020-01-26 18:18:49 +01:00
idle_inhibit_v1.c	Apply clang-format	2020-02-18 21:20:23 +01:00
idle_inhibit_v1.h	Replace all wayland-server.h includes with wayland-server-core.h	2019-12-20 17:16:53 +01:00
LICENSE	Refactor surface damaging and rendering code	2020-01-11 17:07:33 +01:00
meson.build	meson: Bump wlroots version	2022-12-17 21:56:03 +01:00
meson_options.txt	Add man page. (#141 )	2020-05-31 15:14:18 +02:00
output.c	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
output.h	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
README.md	readme: drop CI badge	2023-01-03 22:30:54 +01:00
seat.c	add wlr_virtual_keyboard_manager_v1 and wlr_virtual_pointer_manager_v1	2023-02-01 00:26:37 +01:00
seat.h	add wlr_virtual_keyboard_manager_v1 and wlr_virtual_pointer_manager_v1	2023-02-01 00:26:37 +01:00
server.h	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
view.c	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
view.h	cage: add basic wlr-output-management support	2023-07-28 15:36:34 +02:00
xdg_shell.c	Port 0.16 scene changes	2022-12-17 21:56:03 +01:00
xdg_shell.h	xdg_shell: Port 0.16 xdg_toplevel changes	2022-12-17 21:56:03 +01:00
xwayland.c	Use scene-graph for damage tracking	2021-12-21 21:53:28 +01:00
xwayland.h	Use scene-graph for damage tracking	2021-12-21 21:53:28 +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 and the Wiki.

Release signatures

Releases are signed with 6EBC43B1 and published on GitHub.

Building and running Cage

You can build Cage with the meson build system. It requires wayland, wlroots, and xkbcommon to be installed. Optionally, install scdoc for manual pages. Note that Cage is developed against the latest tag of wlroots, in order to not constantly chase breaking changes as soon as they occur.

Simply execute the following steps to build Cage:

$ meson build
$ ninja -C build

By default, this builds a debug build. To build a release build, use meson build --buildtype=release.

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. For more configuration options, see Configuration.

Cage is based on the annotated source of tinywl and rootston.

Bugs

For any bug, please create an issue on GitHub.

License

Please see LICENSE on GitHub.