logo

inaban

Distrustful Wayland Compositor (inspired by XMonad and dwm) git clone https://hacktivis.me/git/inaban.git

README.md (1480B)


  1. <!--
  2. SPDX-FileCopyrightText: 2019-2022 inaban Authors <https://hacktivis.me/git/inaban>
  3. SPDX-License-Identifier: BSD-3-Clause
  4. -->
  5. ## inaban
  6. Inaban: Nickname of “稲葉姫子 (Inaba Himeko)”, a character in Kokoro Connect. Picked her for her personality regarding reality and trust.
  7. # Dependencies
  8. - wlroots 0.13.0+
  9. - Wayland: wayland-server, wayland-scanner, wayland-protocols
  10. - (lib)xkbcommon
  11. - a [`checkpassword`](https://cr.yp.to/checkpwd.html) implementation
  12. # Installation
  13. The usual `make ; make install` works. Running inaban as root (setuid included) is unsupported, you need to use something like seatd or {e,systemd-}logind.
  14. # Inspirations
  15. ## XMonad
  16. - Most of the shortcuts
  17. ## dwm
  18. - configuration and related code
  19. ## cage, sway, rootston
  20. - wlroots related code
  21. ## Design and Goals/Non-Goals/…
  22. Refer to:
  23. - <./security.md>
  24. - <./accessibility.md>
  25. # Goals
  26. - No client side decorations, might have borders on all the boxes (rendering and hitbox, should they ever manage to differ)
  27. - Programs wanting to have more than simply asking for a regular surface should need special permissions
  28. - listing of the surfaces should be something similar to a capability
  29. - special position/size should be completely managed by the compositor
  30. - resizes other than done by the compositor are denied
  31. - If there is tiling should be powerful (like XMonad) yet simple (unlike i3)
  32. ## Non-Goals
  33. - XWayland as anything but a separated Wayland client (would recommend cage for this)