Warning, /plasma/breeze-plymouth/README is written in an unsupported language. File is not indexed.

0001 # Branding
0002 ## CMake
0003 Use CMake to set the common overridden variables.
0004 ```
0005 cmake -DDISTRO_NAME=KDistro
0006       -DDISTRO_VERSION=123
0007       -DDISTRO_LOGO=kdistro
0008       -DBACKGROUND_TOP_COLOR=kdistro_green
0009       -DBACKGROUND_BOTTOM_COLOR=kdistro_blue
0010       ..
0011 ```
0012 
0013 ## Graphics (breeze)
0014 
0015 Branding in the graphics mode is done via the code in
0016 breeze.script. Do note the guidelines below when changing things.
0017 In particular you want to change the following variables
0018 
0019 ```
0020 // Title and font settings.
0021 global.title.text = "Plasma 5.6";
0022 global.defaults.font.default = "Noto Sans 12";
0023 global.defaults.font.title = "Noto Sans 14";
0024 
0025 // Same color or different for gradient.
0026 palette.background.top = colors.plasma_blue;
0027 palette.background.bottom = colors.icon_blue;
0028 ```
0029 
0030 ## Text (breeze-text)
0031 
0032 The text theme is configured via the .plymouth theme file,
0033 so you can simply install your own theme file to apply branding.
0034 
0035 ```
0036 [Plymouth Theme]
0037 Name=Our theme (text)
0038 Description=A splash for text mode
0039 ModuleName=breeze-text
0040 
0041 [breeze-text]
0042 title=openSUSE 14
0043 black=0xfcfcfc # This is the background
0044 white=0x000000 # This is the progress bar & title
0045 ```
0046 
0047 ## Grub
0048 
0049 breeze/breeze.grub is a special grub scripting file which mostly sets sane
0050 defaults in the event that breeze-grub (when used) is malfunctioning. You can
0051 simply cat the file into your grub.cfg (happens automatically on Debian systems
0052 when the plymouth theme is configured as default)
0053 
0054 # Design Guideline
0055 ## Logo
0056 
0057 - 128x128
0058 - A monochrome logo is fine, it should use a color consistent with the
0059   default font color though (default is "Cardboard Grey")
0060 
0061 ## 16bit
0062 
0063 - Solid color background. We default to the same color as GRUB
0064 - None of the graphics must have transparent parts (see below for why)
0065 - Logo must be monochrome contrastful color consistent with font color.
0066   We default to "Cardboard Grey".
0067 - Text must use same color as Logo.
0068 
0069 # 16bit - What? Why? How?
0070 Sometimes text displays offer no more than 4 bits per pixel, for these cases we
0071 have a special 16 color version of images. Those images should not contain
0072 alpha channels and use solid color throughout (no gradients etc.).
0073 
0074 In the script itself we use a solid color background, the images should use
0075 matching colors when needing to avoid alpha.
0076 
0077 Usually the workflow is to take the regular version and replace the alpha,
0078 then possibly also overly colorful elements, save it and convert to 16 colors.
0079 Most of the time you can use drop shadows, but all in all no more than 16
0080 colors can be used, so you will have to make sure the clipped version's drop
0081 is still appearing as expected.
0082 
0083 When converting to <= 16bit colors please note that you first want to assign a
0084 static background color for fully transparent bits that matches the background
0085 color used in the script. Since alpha transparency is possibly not available
0086 or limited to 4bits any transparency will be stripped as part of quantization.
0087 
0088 To assing a background and convert to <= 16bit color version
0089 (< when fewer colors found) you can use:
0090 ```
0091   for foo in *; do
0092     convert $foo -alpha Background -background "#000000" -fill "#000000" -flatten $foo
0093     pngtopnm $foo | pnmquant 16 | pnmtopng > 16.png; mv 16.png $foo
0094   done
0095 ```
0096 
0097 You may want to check that the output makes sense.