aerothemeplasma/INSTALL.md
2025-02-06 01:16:18 +00:00

148 lines
8.4 KiB
Markdown

# Installation
## TABLE OF CONTENTS
1. [Prerequisites](#preq)
2. [Plasma components](#plasma)
3. [KWin components](#kwin)
4. [Miscellaneous components](#misc)
5. [Configuring AeroThemePlasma](#conf)
## Prerequisites <a name="preq"></a>
**NOTE**: Dependencies for other disros besides Arch Linux have been provided by contributors and aren't updated frequently, which may result in incorrect or missing dependencies.
### Arch Linux
Required packages:
```bash
pacman -S cmake extra-cmake-modules ninja qt6-virtualkeyboard qt6-multimedia qt6-5compat plasma-wayland-protocols plasma5support kvantum base-devel
```
- (optionally) plymouth
### Kubuntu
Required Packages:
```bash
apt install build-essential cmake ninja-build curl libqt6virtualkeyboard6 libqt6multimedia6 libqt6core5compat6 libplasma5support6 libkdecorations2-dev libkf6colorscheme-dev libkf6i18n-dev libkf6iconthemes-dev libkf6kcmutils-dev libkirigami-dev libkf6kio-dev libkf6notifications-dev libkf6svg-dev libkf6crash-dev libkf6globalaccel-dev libplasma-dev libplasmaactivities-dev libxcb-composite0-dev libxcb-randr0-dev libxcb-shm0-dev libxcb-damage0-dev libepoxy-dev libqt6svg6-dev kwin-dev plasma-wayland-protocols
```
### Fedora KDE
Required Packages:
```bash
dnf install plasma-workspace-devel kvantum qt6-qtmultimedia-devel qt6-qt5compat-devel libplasma-devel qt6-qtbase-devel qt6-qtwayland-devel plasma-activities-devel kf6-kpackage-devel kf6-kglobalaccel-devel qt6-qtsvg-devel wayland-devel plasma-wayland-protocols kf6-ksvg-devel kf6-kcrash-devel kf6-kguiaddons-devel kf6-kcmutils-devel kf6-kio-devel kdecoration-devel kf6-ki18n-devel kf6-knotifications-devel kf6-kirigami-devel kf6-kiconthemes-devel cmake gmp-ecm-devel kf5-plasma-devel libepoxy-devel kwin-devel kf6-karchive kf6-karchive-devel plasma-wayland-protocols-devel qt6-qtbase-private-devel qt6-qtbase-devel plymouth-devel plymouth-plugin-script
```
## Compiling
To build the components that need to be compiled (KWin effects, Decoration theme, etc.), run ```compile.sh```:
```bash
$ chmod +x compile.sh && ./compile.sh
```
or
```bash
$ sh compile.sh
```
## Plasma components <a name="plasma"></a>
This section relates to the directories found in the ```plasma``` folder.
1. Move the ```smod``` folder to ```~/.local/share```, or ```/usr/share/``` for a system-wide installation. This will install the resources required by many other components in this project.
2. Move the folders ```desktoptheme```, ```look-and-feel```, ```plasmoids```, ```layout-templates```, ```shells``` into ```~/.local/share/plasma```. If the folder doesn't exist, create it. These folders contain the following:
- Plasma Style
- Global Theme (more accurately, just the lock screen)
- Plasmoids
- Plasma shell
- Preset panel layout that can be applied from Edit mode
3. Move ```sddm-theme-mod``` to ```/usr/share/sddm/themes```. Optionally, to enable the Vista start screen, set ```enableStartup=true``` in ```theme.conf.user```
4. Import and apply the color scheme through System Settings.
7. When applying the global theme, only apply the splash screen and uncheck everything else.
## KWin components <a name="kwin"></a>
This section relates to the directories found in the ```kwin``` folder.
1. Move ```effects```, ```tabbox```, ```outline```, ```scripts``` to ```~/.local/share/kwin```.
2. In System Settings, apply the following settings:
- In Window Behavior -> Titlebar Actions:
- Mouse wheel: Do nothing
- In Window Behavior -> Task Switcher:
- Main: Thumbnail Seven, Include "Show Desktop" entry
- Alternative: Flip Switch, Forward shortcut: Meta+Tab
- In Window Behavior -> KWin Scripts:
- Enable Minimize All, SMOD Peek
- In Window Behavior -> Desktop Effects, enable the following:
- Aero Glass Blur
- Aero Glide
- Desaturate Unresponsive Applications
- Fading Popups
- Login
- SMOD Glow
- SMOD Snap
- Squash
- SMOD Peek
- Dim Screen for Administrator Mode
- In Window Behavior -> Desktop Effects, **disable** the following:
- Background Contrast
- Blur
- Maximize
- Sliding Popups
- Dialog Parent
- Dim Inactive
- Logout
## Miscellaneous components <a name="misc"></a>
This section relates to the directories found in the ```misc``` folder.
1. Move the ```Kvantum``` folder (the one inside the ```kvantum``` folder) to ```~/.config```, then in Kvantum Manager select the theme.
2. Unpack the sound archive and move the folders to ```~/.local/share/sounds```, then select the sound theme in System Settings.
3. Unpack the icon archive and move the folder to ```~/.local/share/icons```, then select the icon theme in System Settings.
4. Unpack the cursor archive and move the folder to ```/usr/share/icons```, then follow [this](https://www.youtube.com/watch?v=Dj7co2R7RKw) guide to install the cursor theme.
5. Move the files located in ```mimetype``` into ```~/.local/share/mime/packages``` and then run ```update-mime-database ~/.local/share/mime``` to fix DLLs and EXE files sharing the same icons.
6. Segoe UI, Segoe UI Bold, Segoe UI Semibold and Segoe UI Italic are required for this theme and they should be installed as system-wide fonts.
If SDDM fails to pick up on the cursor theme, go to System Settings -> Startup and Shutdown -> Login Screen (SDDM), and click on Apply Plasma Settings to enforce your current cursor theme, and other relevant settings. Do this *after* installing everything else. If even that fails, change the default cursor theme in ```/usr/share/icons/default/index.theme``` to say ```aero-drop```.
## Configuring AeroThemePlasma <a name="conf"></a>
1. After installing everything, restart KDE Plasma and KWin.
2. On a fresh KDE install, **remove** the default panel and add the "AeroThemePlasma Taskbar" panel using Edit mode. You can also manually configure the panel for a finer setup.
3. Disable the following entries in the system tray settings:
- Power and Battery
- Networks
- Keyboard Layout
- Audio Volume
And enable the following entries:
- Battery
- Network Management
- Sound Mixer
4. When updating KDE Plasma, usually through a full system upgrade, recompiling KWin effects and the DefaultToolTip component is necessary.
5. In System Settings -> Session -> Desktop Session, uncheck the "Ask for confirmation" option.
6. In System Settings -> Keyboard -> Shortcuts, under KWin, disable the "Peek at Desktop" shortcut, and remap the "MinimizeAll" to Meta+D
7. In System Settings -> Fonts, configure the fonts as shown here:
<img src="screenshots/fontconfig.png">
The following steps are optional:
8. To enable full font hinting just for Segoe UI, move the ```fontconfig``` folder to ```~/.config```. This will enable full font hinting for Segoe UI while keeping slight font hinting for other fonts. Additionally, append ```QML_DISABLE_DISTANCEFIELD=1``` into ```/etc/environment``` in order for this to be properly applied. *While full font hinting makes the font rendering look sharper and somewhat closer to Windows 7's ClearType, on Linux this option causes noticeably faulty kerning. This has been a [prominent](https://github.com/OpenTTD/OpenTTD/issues/11765) [issue](https://gitlab.gnome.org/GNOME/pango/-/issues/656) [for](https://gitlab.gnome.org/GNOME/pango/-/issues/463) [several](https://gitlab.gnome.org/GNOME/pango/-/issues/404) [years](https://github.com/harfbuzz/harfbuzz/issues/2394) [now](https://www.phoronix.com/news/HarfBuzz-Hinting-Woe) and while the situation has improved from being unreadable to just being ugly, a complete solution for this doesn't seem to be coming anytime soon.*
9. For Wine users it's recommended to install the [VistaVG Ultimate](https://www.deviantart.com/vishal-gupta/art/VistaVG-Ultimate-57715902) msstyles theme.
10. To install custom branding at the Info Center, move ```kcm-about-distrorc``` from the ```branding``` folder to ```~/.config/kdedefaults/```, then edit the file's ```LogoPath``` entry to point to the absolute path of ```kcminfo.png```.
11. Add the following to ```~/.bashrc``` to get bash to look more like the command prompt on Windows:
```bash
PS1='C:${PWD//\//\\\\}> '
echo -e "Microsoft Windows [Version 6.1.7600]\nCopyright (c) 2009 Microsoft Corporation. All rights reserved.\n"
```
12. In the terminal emulator of your choice (e.g Konsole), set the font to [TerminalVector](https://www.yohng.com/software/terminalvector.html), size 9pt. Disable smooth font rendering and bold text, reduce the line spacing and margins to 0px, set the cursor shape to underline, and enable cursor blinking.