search

baduhai / Koi

Koi - Theme scheduling for the KDE Plasma Desktop
GNU Lesser General Public License v3.0
270 stars 20 forks source link

readme

Koi

Koi

Scheduling LIGHT/DARK Theme Converter for the KDE Plasma Desktop

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.

Features

Screenshots

Screenshots

Using Koi

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.

Startup/Autostart

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.

Getting Koi

Latest version: 0.3.1

Building from SOURCE

GENERIC Dependencies

KDE Frameworks [Development files]:

KDE Plasma Desktop Environment

QT [Development files]:

CMake Program

Build Instructions

  1. git clone https://github.com/baduhai/Koi.git | git clone git@github.com:baduhai/Koi.git | gh repo clone baduhai/Koi

  2. cmake -S "./Koi/src/" -B "./Koi/src/build/"

  3. sudo make -C "./Koi/src/build/"

  4. sudo make -C "./Koi/src/build/" install # This will 'install' Koi into /usr/local/bin/

Building with NIX (OS)

nix-build -E 'with import <nixpkgs> {}; pkgs.libsForQt5.callPackage ./dev.nix {}'

Prerequisites:

Arch Linux - [AUR]

Build Dependencies:

Run Dependencies:

openSUSE TumbleWeed - [OBS]

Build Dependencies:

Run Dependencies:

openSUSE Leap - [OBS]

Build Dependencies:

Run Dependencies:

Fedora - [COPR]

Build Dependencies:

Run Dependencies:

Debian/Ubuntu

Build Dependencies:

Run Dependencies:

KDE Neon

Build Dependencies:

Run Dependencies:

Void Linux

Build Dependencies:

Run Dependencies:

NixOS - [NUR]

Credits:

References:

The following is a list of resources that was used as reference and inspiration for writing Koi.