Repository files navigation

Responsive shell for the Liri desktop.

Compiler requirements:

• gcc >= 4.8 or
• Clang

Qt >= 6.6.0 with at least the following modules is required:

• qtbase
• qtdeclarative
• qtwayland
• qtgraphicaleffects
• qtquickcontrols2
• qtsvg

The following modules and their dependencies are required:

• cmake >= 3.19.0
• extra-cmake-modules >= 5.245.0
• cmake-shared >= 2.0.99
• fluid >= 2.0.0
• qtaccountsservice >= 2.0.0
• qtgsettings >= 2.0.0
• qtshellintegration
• libliri
• aurora-scanner
• aurora-compositor
• pam
• polkit-qt-1
• solid

mkdir buildcd buildcmake -DCMAKE_INSTALL_PREFIX=/path/to/prefix ..makemake install# use sudo if necessary

Replace/path/to/prefix to your installation prefix.Default is/usr/local.

You can also append the following options to thecmake command:

• -DFEATURE_liri_development_build:BOOL=ON: Enable feature for development such as theability to load arbitrary QML files.
• -DFEATURE_enable_systemd:BOOL=OFF: Disable systemd support.
• -DFEATURE_shell_enable_qtquick_compiler:BOOL=ON: Build with QtQuick compiler.
• -DINSTALL_SYSTEMDUSERUNITDIR=/path/to/systemd/user: Path to install systemd user units (default:/usr/local/lib/systemd/user).

Licensed under the terms of the GNU General Public License version 3 or,at your option, any later version.

Qt 5.2 introduced logging categories and Liri Shell takes advantage ofthem to make debugging easier.

Please refer to theQt documentationto learn how to enable them.

• Compositor:

  • liri.compositor: Compositor
  • liri.screensaver: Lock, idle and inhibit interface
  • liri.session: Manages the session
  • liri.loginmanager: login manager subsystem
  • liri.loginmanager.logind: login manager subsystem (logind backend)
  • liri.shell: Shell
  • liri.gtkshell: Gtk shell support
  • liri.outputmanagement: Output management
  • liri.decoration: Window decorations
  • liri.shell.liricolorpickerv1: LiriColorPickerV1 Wayland protocol
  • liri.shell.lirilockscreenv1: LiriLockScreenV1 Wayland protocol
  • liri.shell.lirimodalv1: LiriModalV1 Wayland protocol
  • liri.shell.lirishellv1: LiriShellV1 Wayland protocol

• Launcher QML plugin:

  • liri.launcher: Launcher model and items
  • liri.launcher.appsmodel: Applications model

• MPRIS2 QML plugin:

  • liri.mpris2: MPRIS2 engine
  • liri.mpris2.player: MPRIS2 player interface

• PolicyKit QML plugin:

  • liri.policykit: PolicyKit agent

You can simulate a fake screen configuration on X11 and Wayland.

Run:

liri-session -- -platform xcb --fake-screen screenconfig.json# replace xcb with wayland if you are running on Wayland

Here's the contents ofscreenconfig.json:

{"outputs": [{"name":"Screen 1","description":"Virtual output 1","primary":false,"scale":1,"position": {"x":0,"y":0},"mode": {"size": {"width":1024,"height":768},"refreshRate":60000},"physicalSize": {"width":350,"height":260}},{"name":"Screen 2","description":"Virtual output 2","primary":true,"scale":1,"position": {"x":1024,"y":0},"mode": {"size": {"width":1024,"height":768},"refreshRate":60000},"physicalSize": {"width":350,"height":260}}]}

Developers can debug Liri Shell with Qt Creator and the QML JavaScript debugger.

Set the debug port and run the shell:

liri-session -- -qmljsdebugger=port:3768

In the example above we are using the default port which is 3768.Now from Qt Creator click on Debug -> Start Debugging -> Attach to QML port and specifythe 3768 port.

See theQt Creator manual for more information.