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

A Wayland kiosk

Find a file

Kenny Levinsen b40be06da2 ci: Upgrade wlroots to 0.17		2024-01-26 23:45:57 +01:00
.github/workflows	ci: Upgrade wlroots to 0.17	2024-01-26 23:45:57 +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	Chase HTTP redirect	2023-08-14 09:18:22 +02:00
cage.c	Switch from wlr_idle to wlr_idle_notify_v1	2024-01-26 23:45:57 +01:00
config.h.in	cage: add -v argument to print version	2020-01-26 18:18:49 +01:00
idle_inhibit_v1.c	Switch from wlr_idle to wlr_idle_notify_v1	2024-01-26 23:45:57 +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: Convert xwayland option to feature type	2024-01-26 23:45:57 +01:00
meson_options.txt	meson: Convert xwayland option to feature type	2024-01-26 23:45:57 +01:00
output.c	output: Use state field in wlr_output_event_commit	2024-01-26 23:45:57 +01:00
output.h	output: Remove output mode handler	2024-01-26 23:45:57 +01:00
README.md	Chase HTTP redirect	2023-08-14 09:18:22 +02:00
seat.c	Switch from wlr_idle to wlr_idle_notify_v1	2024-01-26 23:45:57 +01:00
seat.h	cage: add relative-pointer-unstable-v1 support	2023-11-10 14:38:28 +01:00
server.h	Switch from wlr_idle to wlr_idle_notify_v1	2024-01-26 23:45:57 +01: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	shell: Use new map/unmap events	2024-01-26 23:45:57 +01:00
xdg_shell.h	xdg_shell: Port 0.16 xdg_toplevel changes	2022-12-17 21:56:03 +01:00
xwayland.c	shell: Use new map/unmap events	2024-01-26 23:45:57 +01:00
xwayland.h	shell: Use new map/unmap events	2024-01-26 23:45:57 +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 up to version 0.1.4 are signed with 6EBC43B1. Releases from 0.1.5 onwards are signed with E88F5E48 All releases are 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.