mirror of
https://invent.kde.org/marcoa/shift-shell.git
synced 2026-04-26 14:23:09 +00:00
SHIFT is an open source shell built on KDE Plasma Mobile, designed to adapt fluidly to your computing needs across devices
This adds support for specifying options needed to deal with phone display panel pecularities (ex. screen curves, notches, punch holes) This is implemented as settings in ~/.config/plasmamobilerc, which can set panel heights, paddings, and center spacings to duck display cutouts. The pixel values are scaling independent, and so are not affected when the display scaling is changed. This is then exposed over DBus, so that components from outside of plasmashell (ex. KWin) can access it easily without needing to connect to kscreen themselves. Each screen is exposed as a single object. Currently support is only added in the status bar and the navigation panel. Currently all screens have the settings applied. In the future, we may want to limit this just to the internal screen (?) --- This also adds a "devices" folder (in `devices/configs`) where per-device configs can be set. This is installed to `/usr/share/plasma-mobile-device-configs`. In `plasmamobilerc` (installed to `/etc/xdg/plasmamobilerc`, or `~/.config/plasmamobilerc`), envmanager will read: ```toml [Device] device=oneplus-enchilada ``` for the device config to use and write its settings to `~/.config/plasma-mobile/plasmamobilerc`. |
||
|---|---|---|
| .reuse | ||
| .well-known | ||
| bin | ||
| components | ||
| containments | ||
| devices | ||
| envmanager | ||
| initialstart | ||
| kcms | ||
| kded | ||
| kwin | ||
| layout-templates | ||
| LICENSES | ||
| lookandfeel | ||
| po | ||
| quicksettings | ||
| screenshots | ||
| shell | ||
| tests | ||
| .git-blame-ignore-revs | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .kde-ci.yml | ||
| CMakeLists.txt | ||
| logo.png | ||
| logo.png.license | ||
| org.kde.plasma.mobileshell.metainfo.xml | ||
| plasma-mobile.service | ||
| plasma-mobile.service.license | ||
| README.md | ||
Plasma Mobile
This repository contains shell components for Plasma Mobile.
- Project page: plasma-mobile.org
- Repository: invent.kde.org/plasma/plasma-mobile
- Documentation: invent.kde.org/plasma/plasma-mobile/-/wikis/home
- Development channel: matrix.to/#/#plasmamobile:matrix.org
Reporting issues
- How to report issues: invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking
- Shell issue tracker: invent.kde.org/plasma/plasma-mobile/-/issues
- General issue tracker: https://invent.kde.org/teams/plasma-mobile/issues/-/issues
Locations
- components/mobileshell - private shell component library (API not guaranteed to be stable!)
- containments - shell panels (homescreens, status bar, task panel)
- kcms - settings module
- look-and-feel - Plasma look-and-feel packages (ex. lockscreen, logout, etc.)
- shell - Plasma shell package, provides implementations for applet and containment configuration dialogs
- quicksettings - quick settings packages for the action drawer
- tests - small runnable snippets that can be used to test parts of the shell without loading all of Plasma
Test on a development machine
See the documentation page for more details.
It is recommended to use kdesrc-build to build this from source. See this page in order to set it up.
Dependencies:
- KDE Frameworks 6 setup (plasma-framework and its dependencies)
- plasma-nano
- plasma-workspace
- plasma-nm
- plasma-pa
- bluez-qt
- Milou (for search)
- Kirigami
- Kirigami Addons
- feedbackd (optional: for vibrations)
To start the shell in a window, run:
QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.mobileshell"
Useful options:
- Specify the
--output-countflag for the number of displays - Specify
--widthand--heightfor the window size
QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.mobileshell" --output-count 2 --width 360 --height 720
Device specific configuration
See [/devices/README.md] for more details on setting device specific configuration (ex. notches, screen curves).