2021-12-23 16:02:41 +00:00
<!--
2024-07-27 03:47:44 +00:00
- SPDX-FileCopyrightText: None
2021-12-23 16:02:41 +00:00
- SPDX-License-Identifier: CC0-1.0
-->
2022-01-18 16:02:38 +00:00
# Plasma Mobile
2014-08-06 08:03:54 +00:00
2022-01-18 16:02:38 +00:00
This repository contains shell components for Plasma Mobile.
2014-11-13 20:29:24 +00:00
2022-04-08 23:27:31 +00:00
* Project page: [plasma-mobile.org ](https://plasma-mobile.org )
2022-04-08 23:31:23 +00:00
* Repository: [invent.kde.org/plasma/plasma-mobile ](https://invent.kde.org/plasma/plasma-mobile )
2022-04-08 23:27:31 +00:00
* Documentation: [invent.kde.org/plasma/plasma-mobile/-/wikis/home ](https://invent.kde.org/plasma/plasma-mobile/-/wikis/home )
* Development channel: [matrix.to/#/#plasmamobile:matrix.org ](https://matrix.to/#/#plasmamobile:matrix.org )
### Reporting issues
* How to report issues: [invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking ](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking )
* Shell issue tracker: [invent.kde.org/plasma/plasma-mobile/-/issues ](https://invent.kde.org/plasma/plasma-mobile/-/issues )
* General issue tracker: [https://invent.kde.org/teams/plasma-mobile/issues/-/issues ](https://invent.kde.org/teams/plasma-mobile/issues/-/issues )
2022-01-18 16:02:38 +00:00
### Locations
2022-03-21 14:05:56 +00:00
* [components/mobileshell ](components/mobileshell ) - private shell component library (API not guaranteed to be stable!)
2022-06-23 04:46:36 +00:00
* [containments ](containments ) - shell panels (homescreens, status bar, task panel)
* [kcms ](kcms ) - settings module
2021-12-23 00:35:46 +00:00
* [look-and-feel ](look-and-feel/contents ) - Plasma look-and-feel packages (ex. lockscreen, logout, etc.)
2022-06-23 04:46:36 +00:00
* [shell ](shell ) - Plasma shell package, provides implementations for applet and containment configuration dialogs
2021-12-23 00:35:46 +00:00
* [quicksettings ](quicksettings ) - quick settings packages for the action drawer
2022-06-18 21:14:21 +00:00
* [tests ](tests ) - small runnable snippets that can be used to test parts of the shell without loading all of Plasma
2021-05-30 23:57:16 +00:00
2022-08-31 19:49:55 +00:00
< img src = "/screenshots/homescreen-folio.png" width = 300px/ >
2024-02-11 23:52:47 +00:00
< img src = "/screenshots/homescreen-halcyon.png" width = 300px/ >
2022-04-08 23:27:31 +00:00
2022-01-18 16:02:38 +00:00
### Test on a development machine
2014-11-13 20:29:24 +00:00
2022-02-18 04:34:59 +00:00
See the [documentation page ](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Building-and-Testing-Locally ) for more details.
2021-12-23 00:35:46 +00:00
It is recommended to use `kdesrc-build` to build this from source. See [this page ](https://community.kde.org/Get_Involved/development ) in order to set it up.
2014-11-13 20:29:24 +00:00
Dependencies:
2023-05-12 22:48:52 +00:00
* KDE Frameworks 6 setup (plasma-framework and its dependencies)
* plasma-nano
* plasma-workspace
* plasma-nm
* plasma-pa
* bluez-qt
* Milou (for search)
2022-06-22 17:43:39 +00:00
* Kirigami
* Kirigami Addons
2025-05-22 15:45:44 +00:00
* feedbackd (optional: for vibrations)
2015-04-20 12:15:15 +00:00
2024-02-27 20:48:26 +00:00
To start the shell in a window, run:
2019-01-11 10:58:48 +00:00
```
2023-11-23 08:05:44 +00:00
QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.mobileshell"
2019-01-11 10:58:48 +00:00
```
2022-04-08 23:27:31 +00:00
2024-02-27 20:48:26 +00:00
Useful options:
- Specify the `--output-count` flag for the number of displays
- Specify `--width` and `--height` for 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
```
panels: Add support for defining device specific panel tweaks
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`.
2025-10-05 23:06:52 +00:00
### Device specific configuration
2025-11-06 12:55:15 +00:00
See [/devices/README.md ](/devices/README.md ) for more details on setting device specific configuration (ex. notches, screen curves).
panels: Add support for defining device specific panel tweaks
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`.
2025-10-05 23:06:52 +00:00
2022-04-08 23:27:31 +00:00
---
< img src = "https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/19a607bb68faa76bbc9f888e33a3aa9a/konqi-calling.png" width = 200px >
< br / >
< img src = "https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/9238173a7cae1d8832d83350eda74f85/developers.png" width = 300px >
