Koi is a program designed to provide the KDE Plasma Desktop functionality to automatically switch between light and dark themes. Koi is under semi-active development, and while it is stable enough to use daily, expect bugs. Koi is designed to be used with Plasma, and while some features may function under different desktop environments, they are unlikely to work and untested.
Koi was written as a project to practice QT by a novice programmer, expect code to be written sloppily.
- Toggle between Light and Dark presets based on time / coordinated schedule
- Change Plasma style
- Change QT Colour scheme
- Change Icon theme
- Change GTK/GNOME theme
- Change Light/Dark wallpapers
- Hide application to system tray
- Enable/Disable notifications about Light/Dark theme switching
- Toggle between LIGHT/DARK themes by clicking middle mouse button (wheel)
Koi is designed to be very simple to use. After the initial run of Koi, settings for the light and dark presets will be empty, all you need to do is select which themes you would like for Koi to manage and select your desired themes by clicking the Preferences button.
If you would like that Koi switch between your light and dark settings automatically, you can select this option in the main page of the program, and choose between following a user set schedule, or at sunrise and sunset (planned/scheduled feature). To switch between light and dark manually right click the tray icon and select the desired preset, or do so from Koi's main window.
In order to have Koi started at login, you can do so with the KDE Plasma System Settings.
Search for: Autostart
Plasma version 5 navigate to System Settings -> Startup and Shutdown -> Autostart; and select "+ Add... -> + Add Application -> Utilities -> Koi"
Plasma version 6 navigate to System Settings -> System -> Autostart, and select "+ Add... -> + Add Application -> Utilities -> Koi"
In addition, it is recommended having the option to Start Koi hidden checked, this will prevent Koi from popping up every time you start your operating system.
Latest version: 0.4
GENERIC Dependencies
KDE Frameworks [Development files]:
- KF 6 Config
- KF 6 Core Addons
- KF 6 Widgets Addons
KDE Plasma Desktop Environment
QT [Development files]:
- QT 6 Core
- QT 6 DBus
- QT 6 Gui
- QT 6 Network
- QT 6 Test
- QT 6 Widgets (Optional)
- QT 6 Xml (Optional)
CMake Program
Build Instructions
-
git clone https://github.com/baduhai/Koi.git|git clone [email protected]:baduhai/Koi.git|gh repo clone baduhai/Koi -
sudo cmake -S "./Koi/src/" -B "./Koi/build/" -
sudo cmake --build "./Koi/build/" -
sudo cmake --install "./Koi/build/"# This will install Koi into '/usr/local/bin/'
Building with NIX (OS)
nix-build -E 'with import <nixpkgs> {}; pkgs.libsForQt5.callPackage ./dev.nix {}'
Arch Linux - [AUR]
Build Dependencies:
'gcc' 'qt6-base' 'qt6-tools' 'qt6-svg' 'cmake' 'extra-cmake-modules'
Run Dependencies:
'plasma-desktop' 'plasma-integration'
openSUSE TumbleWeed - [OBS]
Build Dependencies:
'cmake' 'cmake-extras' 'kf6-kconfigwidgets-devel' 'kf6-kconfig-devel' 'kf6-kcoreaddons-devel' 'qt6-base' 'qt6-dbus-devel' 'qt6-gui-devel' 'qt6-network-devel' 'qt6-test-devel' 'qt6-widgets-devel' 'qt6-xml-devel' 'hicolor-icon-theme'
Run Dependencies:
'plasma6-desktop'
openSUSE Leap - [OBS]
Build Dependencies:
'cmake' 'cmake-extras' 'kf5-kconfigwidgets-devel' 'kf5-kconfig-devel' 'kf5-kcoreaddons-devel' 'qt5-dbus-devel' 'qt5-gui-devel' 'qt5-network-devel' 'qt5-test-devel' 'qt5-widgets-devel' 'qt5-xml-devel' 'hicolor-icon-theme'
Run Dependencies:
'plasma5-desktop' 'plasma-framework-components' 'plasma-framework-desktoptheme'
Fedora - [COPR]
Build Dependencies:
'cmake' 'extra-cmake-modules' 'kf6-kconfigwidgets-devel' 'kf6-kconfig-devel' 'kf6-kcoreaddons-devel' 'kf6-kwidgetsaddons-devel' 'qt6-qtbase-devel' 'hicolor-icon-theme'
Run Dependencies:
'plasma-desktop' 'plasma-integration' 'plasma-workspace'
Build Dependencies:
'g++' 'cmake' 'cmake-extras' 'libkf5config-dev' 'libkf5coreaddons-dev' 'libkf5dbusaddons-dev' 'libkf5widgetsaddons-dev' 'qtbase5-dev'
Run Dependencies:
'kde-plasma-desktop' 'plasma-framework' 'plasma-integration' 'plasma-workspace'
Build Dependencies:
'g++' 'cmake' 'cmake-extras' 'libkf6config-dev' 'libkf6coreaddons-dev' 'libkf6dbusaddons-dev' 'libkf6widgetsaddons-dev' 'qtbase6-dev'
Run Dependencies:
'kde-plasma-desktop' 'plasma-desktop' 'plasma-integration' 'plasma-workspace'
Build Dependencies:
'gcc' 'cmake' 'extra-cmake-modules' 'qt6-base-devel' 'kf6-kcoreaddons-devel' 'kf6-kconfig-devel' 'kf6-kwidgetsaddons-devel'
Run Dependencies:
'plasma-desktop' 'plasma-integration' 'qt6-base'
NixOS - [NUR]
- Install to your NIX profile with
nix-env -iA koi -f https://github.com/baduhai/nur/tarball/master, to add to you nixos configuration, follow the Instructions on the NUR repo.
- William Franco Abdul Hai (baduhai)
- Martin Stibor (Martin von Reichenberg)
- DucVietCao
- PassportMidi
- Giovanni Santini (Itachi San)
- FinanceLurker
- Ari Melody
- ToBoil-Features
The following is a list of resources that was used as reference and inspiration for writing Koi.
- Yin-Yang - For UI layout and features inspiration.
- system-tray-icon-qt - For teaching me how to implement a system tray icon with Qt.
- plasma-theme-switcher - For teaching me how to set current Qt color scheme.
- ksetwallpaper - For teaching me how to set the wallpaper on Plasma.
- SunRise - For scheduled sunrise/sunset light/dark theme switching.
- CTPL - Extra library for parallel job execution.
- Scheduler - For timed light/dark theme switching.
- This blog post from Zren - For teaching me how to set the icon theme.