plasma/plasma-mobile/README.md

0001 <!--
0002 - SPDX-FileCopyrightText: None
0003 - SPDX-License-Identifier: CC0-1.0
0004 -->
0005
0006 # Plasma Mobile
0007
0008 This repository contains shell components for Plasma Mobile.
0009
0010 * Project page: [plasma-mobile.org](https://plasma-mobile.org)
0011 * Repository: [invent.kde.org/plasma/plasma-mobile](https://invent.kde.org/plasma/plasma-mobile)
0012 * Documentation: [invent.kde.org/plasma/plasma-mobile/-/wikis/home](https://invent.kde.org/plasma/plasma-mobile/-/wikis/home)
0013 * Development channel: [matrix.to/#/#plasmamobile:matrix.org](https://matrix.to/#/#plasmamobile:matrix.org)
0014
0015 ### Reporting issues
0016 * How to report issues: [invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Issue-Tracking)
0017 * Shell issue tracker: [invent.kde.org/plasma/plasma-mobile/-/issues](https://invent.kde.org/plasma/plasma-mobile/-/issues)
0018 * General issue tracker: [https://invent.kde.org/teams/plasma-mobile/issues/-/issues](https://invent.kde.org/teams/plasma-mobile/issues/-/issues)
0019
0020 ### Locations
0021 * [components/mobileshell](components/mobileshell) - private shell component library (API not guaranteed to be stable!)
0022 * [containments](containments) - shell panels (homescreens, status bar, task panel)
0023 * [kcms](kcms) - settings module
0024 * [look-and-feel](look-and-feel/contents) - Plasma look-and-feel packages (ex. lockscreen, logout, etc.)
0025 * [shell](shell) - Plasma shell package, provides implementations for applet and containment configuration dialogs
0026 * [quicksettings](quicksettings) - quick settings packages for the action drawer
0027 * [tests](tests) - small runnable snippets that can be used to test parts of the shell without loading all of Plasma
0028
0029 <img src="/screenshots/homescreen-halcyon.png" width=300px/>
0030 <img src="/screenshots/homescreen-folio.png" width=300px/>
0031
0032 ### Test on a development machine
0033
0034 See the [documentation page](https://invent.kde.org/plasma/plasma-mobile/-/wikis/Building-and-Testing-Locally) for more details.
0035
0036 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.
0037
0038 Dependencies:
0039 * KDE Frameworks 6 setup (plasma-framework and its dependencies)
0040 * plasma-nano
0041 * plasma-workspace
0042 * plasma-nm
0043 * plasma-pa
0044 * bluez-qt
0045 * Milou (for search)
0046 * Kirigami
0047 * Kirigami Addons
0048 * hfd-service (optional: for vibrations)
0049
0050 To start the phone homescreen in a window, run:
0051 ```
0052 QT_QPA_PLATFORM=wayland dbus-run-session kwin_wayland --xwayland "plasmashell -p org.kde.plasma.mobileshell"
0053 ```
0054
0055 ---
0056
0057 <img src="https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/19a607bb68faa76bbc9f888e33a3aa9a/konqi-calling.png" width=200px>
0058
0059 <br/>
0060
0061 <img src="https://invent.kde.org/plasma/plasma-mobile/-/wikis/uploads/9238173a7cae1d8832d83350eda74f85/developers.png" width=300px>