Difference between revisions of "Plasma/Create a Global Theme Package"

m (Ognarb moved page Plasma/Create a Look and Feel Package to Plasma/Create a Global Theme Package without leaving a redirect: Part of translatable page "Plasma/Create a Look and Feel Package")
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
<languages />
 +
<translate>
 +
== How to create your own Look and Feel package == <!--T:1-->
  
== How to create your own Look and Feel package ==
+
<!--T:2-->
 
 
 
First of all we need to install '''Plasma Look And Feel Explorer''', which is a part of the '''plasma-sdk''' package.
 
First of all we need to install '''Plasma Look And Feel Explorer''', which is a part of the '''plasma-sdk''' package.
  
 +
<!--T:3-->
 
Plasma Look and Feel Explorer is a rather simple app.
 
Plasma Look and Feel Explorer is a rather simple app.
 
On the right panel/side you have three options:
 
On the right panel/side you have three options:
  
* '''A list of installed look and feel themes''' in your system, so you can pick one and edit it directly.
+
<!--T:4-->
*'''Open Theme folder''' - It opens a directory where look and feel themes are saved.
+
* '''A list of installed look and feel themes''' in your system, so you can pick one and edit it directly.</translate>
''/home/yourusername/.local/share/plasma/look-and-feel/''
+
<translate>
 +
<!--T:5-->
 +
*'''Open Theme folder''' - It opens a directory where look and feel themes are saved.<br /><tt>/home/yourusername/.local/share/plasma/look-and-feel/</tt></translate>
 +
<translate>
 +
<!--T:6-->
 
*'''New Theme''', where you can fill in all details of your theme, like name, author etc. You need to fill in all the fields, otherwise  the ''OK'' button will stay grayed out. If you click ''OK'' you will get a notification saying ''Plasma Layout successfully duplicated''.
 
*'''New Theme''', where you can fill in all details of your theme, like name, author etc. You need to fill in all the fields, otherwise  the ''OK'' button will stay grayed out. If you click ''OK'' you will get a notification saying ''Plasma Layout successfully duplicated''.
  
You can now chose your freshly created look and feel theme from the list of available themes and edit it in the main window.
+
<!--T:7-->
 
+
You can now choose your freshly created look and feel theme from the list of available themes and edit it in the main window.
*'''Main window'''
 
It is rather self-explanatory. You can edit details of your look an feel package (name, author, etc). These details are saved into metadata.desktop in your look and feel directory. You also have two buttons there:
 
 
 
*'''Layout from current Plasma setup'''
 
It saves your current desktop layout like placement of panels, plasma applets, wallpaper etc. TODO Add some info what is exactly saved here. All these settings are saved into:
 
  
''.local/share/plasma/look-and-feel/nameofyourtheme/contents/layout/org.kde.plasma.desktop-layout.js''
+
<!--T:8-->
 +
*'''Main window'''<br />It is rather self-explanatory. You can edit details of your look and feel package (name, author, etc). These details are saved into metadata.desktop in your look and feel directory. You also have two buttons there:
  
This is a javascript file executed when you check "Use desktop layout from theme" in the Look And Feel module of System Settings.  If your look and feel theme does not change desktop layout, you can safely remove that file.
+
<!--T:9-->
 +
*'''Layout from current Plasma setup'''<br />It saves your current desktop layout like placement of panels, plasma applets, wallpaper etc. All these settings are saved into:</translate><br /><br /><translate>
 +
<!--T:10-->
 +
<tt>.local/share/plasma/look-and-feel/nameofyourtheme/contents/layouts/org.kde.plasma.desktop-layout.js</tt></translate><br /><br /><translate>
 +
<!--T:11-->
 +
This is a javascript file executed when you check "Use desktop layout from theme" in the Look And Feel module of System Settings.  If your look and feel theme does not change desktop layout, you can safely remove that file.</translate><br /><br /><translate>
 +
<!--T:12-->
 +
The content of the Javascript file will recreate a plasma configuration mirroring the contents of your current main plasma configuration file: <tt>~/.config/plasma-org.kde.plasma.desktop-appletsrc</tt>
  
The content of the Javascript file will recreate a plasma configuration mirroring the contents of your current main plasma configuration file: ~/.config/plasma-org.kde.plasma.desktop-appletsrc
 
  
*'''Defaults from current setup'''*
+
<!--T:66-->
It creates a
+
If you want to have more granular control over what exactly happens with your theme, especially with the layout you can use [[Special:myLanguage/KDE_System_Administration/PlasmaDesktopScripting|Plasma desktop scripting]]. Check out this [[Special:myLanguage/Plasma/How_to_create_a_Unity-like_look_and_feel_theme_using_Plasma%E2%80%99s_Desktop_Scripting_API|tutorial]] for more info.
''.local/share/plasma/look-and-feel/nameofyourtheme/contents/"default"''
 
file where the following settings are saved.
 
  
*widget style
+
<!--T:13-->
*color scheme
+
*'''Defaults from current setup'''<br />It creates a file:</translate><br /><translate>
*icons
+
<!--T:14-->
*plasma theme
+
<tt>.local/share/plasma/look-and-feel/nameofyourtheme/contents/"default"</tt></translate><br /><translate>
*cursor theme
+
<!--T:15-->
*window switcher
+
The following settings are saved:</translate>
*desktop switcher
+
<translate>
*window decoration.
+
<!--T:16-->
 +
**widget style</translate>
 +
<translate>
 +
<!--T:17-->
 +
**color scheme</translate>
 +
<translate>
 +
<!--T:18-->
 +
**icons</translate>
 +
<translate>
 +
<!--T:19-->
 +
**plasma theme</translate>
 +
<translate>
 +
<!--T:20-->
 +
**cursor theme</translate>
 +
<translate>
 +
<!--T:21-->
 +
**window switcher</translate>
 +
<translate>
 +
<!--T:22-->
 +
**desktop switcher</translate>
 +
<translate>
 +
<!--T:23-->
 +
**window decoration.
  
 +
<!--T:24-->
 
You can also add an image which will be used as a preview, stored in
 
You can also add an image which will be used as a preview, stored in
''.local/share/plasma/look-and-feel/nameofyourtheme/contents/preview''
+
<tt>.local/share/plasma/look-and-feel/nameofyourtheme/contents/preview</tt>
  
== How to add dependencies from KDE Store. ==
+
== How to add dependencies from KDE Store. == <!--T:25-->
  
 +
<!--T:26-->
 
First of all you need to add
 
First of all you need to add
X-KPackage-Dependencies=
+
{{Input|1=X-KPackage-Dependencies=}}
 
 
 
to your metadata.desktop. Lets take a look at this example
 
to your metadata.desktop. Lets take a look at this example
  
Elementary Luna
+
<!--T:27-->
Plasma Color Schemes
+
[https://store.kde.org/p/1001720 Elementary Luna Plasma Color Schemes]
https://store.kde.org/p/1001720
 
  
  X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001720
+
  <!--T:28-->
 +
{{Input|1=X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001720}}
  
 +
<!--T:29-->
 
'''kns://''' - the name of the protocol
 
'''kns://''' - the name of the protocol
  
 +
<!--T:30-->
 
'''colorschemes.knsrc''' - type of the resource we want to download (color scheme in that case)
 
'''colorschemes.knsrc''' - type of the resource we want to download (color scheme in that case)
 
Here is a list of available resources on my system (/etc/xdg)
 
Here is a list of available resources on my system (/etc/xdg)
  
 +
<!--T:31-->
 
*aurorae.knsrc
 
*aurorae.knsrc
 +
 +
<!--T:32-->
 
*cgcgtk3.knsrc
 
*cgcgtk3.knsrc
 +
 +
<!--T:33-->
 
*cgcicon.knsrc
 
*cgcicon.knsrc
 +
 +
<!--T:34-->
 
*cgctheme.knsrc
 
*cgctheme.knsrc
 +
 +
<!--T:35-->
 
*colorschemes.knsrc
 
*colorschemes.knsrc
 +
 +
<!--T:36-->
 
*comic.knsrc
 
*comic.knsrc
 +
 +
<!--T:37-->
 
*discover_ktexteditor_codesnippets_core.knsrc
 
*discover_ktexteditor_codesnippets_core.knsrc
 +
 +
<!--T:38-->
 
*emoticons.knsrc
 
*emoticons.knsrc
 +
 +
<!--T:39-->
 
*icons.knsrc  
 
*icons.knsrc  
 +
 +
<!--T:40-->
 
*kfontinst.knsrc
 
*kfontinst.knsrc
 +
 +
<!--T:41-->
 
*ksysguard.knsrc
 
*ksysguard.knsrc
 +
 +
<!--T:42-->
 
*kwineffect.knsrc
 
*kwineffect.knsrc
 +
 +
<!--T:43-->
 
*kwinscripts.knsrc
 
*kwinscripts.knsrc
 +
 +
<!--T:44-->
 
*kwinswitcher.knsrc
 
*kwinswitcher.knsrc
 +
 +
<!--T:45-->
 
*lookandfeel.knsrc
 
*lookandfeel.knsrc
 +
 +
<!--T:46-->
 
*plasma-themes.knsrc
 
*plasma-themes.knsrc
 +
 +
<!--T:47-->
 
*plasmoids.knsrc
 
*plasmoids.knsrc
 +
 +
<!--T:48-->
 
*sddmtheme.knsrc
 
*sddmtheme.knsrc
 +
 +
<!--T:49-->
 
*servicemenu.knsrc
 
*servicemenu.knsrc
 +
 +
<!--T:50-->
 
*wallpaper.knsrc
 
*wallpaper.knsrc
 +
 +
<!--T:51-->
 
*xcursor.knsrc
 
*xcursor.knsrc
  
  
 +
<!--T:52-->
 
'''api.kde-look.org/1001720''' - the url to the content stored on the server, from my experience ''api.kde-look.org/'' is always the same, only id changes. You can get the id from the kde store url ''https://store.kde.org/p/1001720'' '''1001720'''.
 
'''api.kde-look.org/1001720''' - the url to the content stored on the server, from my experience ''api.kde-look.org/'' is always the same, only id changes. You can get the id from the kde store url ''https://store.kde.org/p/1001720'' '''1001720'''.
  
You can specify more than one dependency. Here is an example from United [https://store.kde.org/p/1167950/] metadata.desktop
+
<!--T:53-->
 +
You can specify more than one dependency. Here is an example from [https://store.kde.org/p/1167950/ United] metadata.desktop
  
X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001495,kns://plasma-themes.knsrc/api.kde-look.org/998797,kns://aurorae.knsrc/api.kde-look.org/1136954
+
<!--T:54-->
 +
{{Input|1=X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001495,kns://plasma-themes.knsrc/api.kde-look.org/998797,kns://aurorae.knsrc/api.kde-look.org/1136954}}
  
 +
<!--T:55-->
 
On JSON:
 
On JSON:
X-KPackage-Dependencies: { "kns://colorschemes.knsrc/api.kde-look.org/1001495", "kns://plasma-themes.knsrc/api.kde-look.org/998797", "kns://aurorae.knsrc/api.kde-look.org/1136954" }
+
{{Input|1=<nowiki>X-KPackage-Dependencies: { "kns://colorschemes.knsrc/api.kde-look.org/1001495", "kns://plasma-themes.knsrc/api.kde-look.org/998797", "kns://aurorae.knsrc/api.kde-look.org/1136954" }</nowiki>}}
  
*Color Scheme (Ambiance)
+
<!--T:56-->
https://store.kde.org/p/1001495
+
* [https://store.kde.org/p/1001495 Color Scheme (Ambiance)]
  
*Plasma theme (Unity Ambiance)
+
<!--T:57-->
https://store.kde.org/p/998797
+
* [https://store.kde.org/p/998797 Plasma theme (Unity Ambiance)]
  
*Aurorae (Blender Ambiance)
+
<!--T:58-->
https://store.kde.org/p/1136954
+
* [https://store.kde.org/p/1136954 Aurorae (Blender Ambiance)]
  
You can install your look and feel package from terminal using ''kpackagetool5 -i "name of your theme"''
+
<!--T:59-->
It will be installed to ''.local/share/plasma/look-and-feel/'' 
+
You can install your look and feel package from terminal using  
 +
{{Input|1=kpackagetool5 -i "name of your theme"}}
 +
It will be installed to <tt>.local/share/plasma/look-and-feel/</tt>
  
This will also install dependencies specified in metadata.desktop, so you can test it locally on your system.
+
<!--T:60-->
Type ''kpackagetool5 -h'' to see more options.
+
This will also install dependencies specified in <tt>metadata.desktop</tt>, so you can test it locally on your system.
 +
Type <code>kpackagetool5 -h</code> to see more options.
  
=== System dependencies  (experimental)==
+
== System dependencies  (experimental)== <!--T:61-->
You can specify system dependencies using their AppStream URI scheme. More information about it can be found here: https://www.freedesktop.org/software/appstream/docs/sect-AppStream-Services-UrlHandler.html
 
  
To look up what's the resource you are looking for, you can check on your system by calling "appstreamcli search <something>"
+
<!--T:62-->
 +
You can specify system dependencies using their AppStream URI scheme. More information about it can be found [https://www.freedesktop.org/software/appstream/docs/sect-AppStream-Services-UrlHandler.html here].
  
 +
<!--T:63-->
 +
To look up what's the resource you are looking for, you can check on your system by calling <code>appstreamcli search <something></code>
 +
 +
<!--T:64-->
 
When the Look and Feel package is installed, if a system dependency is specified, it will be the system deciding how to install it, most likely using PackageKit.
 
When the Look and Feel package is installed, if a system dependency is specified, it will be the system deciding how to install it, most likely using PackageKit.
 +
 +
<!--T:65-->
 +
[[Category:Tutorials]]
 +
</translate>

Latest revision as of 14:22, 6 September 2020

Other languages:
English • ‎українська

How to create your own Look and Feel package

First of all we need to install Plasma Look And Feel Explorer, which is a part of the plasma-sdk package.

Plasma Look and Feel Explorer is a rather simple app. On the right panel/side you have three options:

  • A list of installed look and feel themes in your system, so you can pick one and edit it directly.
  • Open Theme folder - It opens a directory where look and feel themes are saved.
    /home/yourusername/.local/share/plasma/look-and-feel/
  • New Theme, where you can fill in all details of your theme, like name, author etc. You need to fill in all the fields, otherwise the OK button will stay grayed out. If you click OK you will get a notification saying Plasma Layout successfully duplicated.

You can now choose your freshly created look and feel theme from the list of available themes and edit it in the main window.

  • Main window
    It is rather self-explanatory. You can edit details of your look and feel package (name, author, etc). These details are saved into metadata.desktop in your look and feel directory. You also have two buttons there:
  • Layout from current Plasma setup
    It saves your current desktop layout like placement of panels, plasma applets, wallpaper etc. All these settings are saved into:

    .local/share/plasma/look-and-feel/nameofyourtheme/contents/layouts/org.kde.plasma.desktop-layout.js

    This is a javascript file executed when you check "Use desktop layout from theme" in the Look And Feel module of System Settings. If your look and feel theme does not change desktop layout, you can safely remove that file.

    The content of the Javascript file will recreate a plasma configuration mirroring the contents of your current main plasma configuration file: ~/.config/plasma-org.kde.plasma.desktop-appletsrc


If you want to have more granular control over what exactly happens with your theme, especially with the layout you can use Plasma desktop scripting. Check out this tutorial for more info.

  • Defaults from current setup
    It creates a file:
    .local/share/plasma/look-and-feel/nameofyourtheme/contents/"default"
    The following settings are saved:
    • widget style
    • color scheme
    • icons
    • plasma theme
    • cursor theme
    • window switcher
    • desktop switcher
    • window decoration.

You can also add an image which will be used as a preview, stored in .local/share/plasma/look-and-feel/nameofyourtheme/contents/preview

How to add dependencies from KDE Store.

First of all you need to add

X-KPackage-Dependencies=

to your metadata.desktop. Lets take a look at this example

Elementary Luna Plasma Color Schemes

X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001720

kns:// - the name of the protocol

colorschemes.knsrc - type of the resource we want to download (color scheme in that case) Here is a list of available resources on my system (/etc/xdg)

  • aurorae.knsrc
  • cgcgtk3.knsrc
  • cgcicon.knsrc
  • cgctheme.knsrc
  • colorschemes.knsrc
  • comic.knsrc
  • discover_ktexteditor_codesnippets_core.knsrc
  • emoticons.knsrc
  • icons.knsrc
  • kfontinst.knsrc
  • ksysguard.knsrc
  • kwineffect.knsrc
  • kwinscripts.knsrc
  • kwinswitcher.knsrc
  • lookandfeel.knsrc
  • plasma-themes.knsrc
  • plasmoids.knsrc
  • sddmtheme.knsrc
  • servicemenu.knsrc
  • wallpaper.knsrc
  • xcursor.knsrc


api.kde-look.org/1001720 - the url to the content stored on the server, from my experience api.kde-look.org/ is always the same, only id changes. You can get the id from the kde store url https://store.kde.org/p/1001720 1001720.

You can specify more than one dependency. Here is an example from United metadata.desktop

X-KPackage-Dependencies=kns://colorschemes.knsrc/api.kde-look.org/1001495,kns://plasma-themes.knsrc/api.kde-look.org/998797,kns://aurorae.knsrc/api.kde-look.org/1136954

On JSON:

X-KPackage-Dependencies: { "kns://colorschemes.knsrc/api.kde-look.org/1001495", "kns://plasma-themes.knsrc/api.kde-look.org/998797", "kns://aurorae.knsrc/api.kde-look.org/1136954" }

You can install your look and feel package from terminal using

kpackagetool5 -i "name of your theme"

It will be installed to .local/share/plasma/look-and-feel/

This will also install dependencies specified in metadata.desktop, so you can test it locally on your system. Type kpackagetool5 -h to see more options.

System dependencies (experimental)

You can specify system dependencies using their AppStream URI scheme. More information about it can be found here.

To look up what's the resource you are looking for, you can check on your system by calling appstreamcli search <something>

When the Look and Feel package is installed, if a system dependency is specified, it will be the system deciding how to install it, most likely using PackageKit.


This page was last edited on 6 September 2020, at 14:22. Content is available under Creative Commons License SA 4.0 unless otherwise noted.