System Library.

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

reionwong e3ab302bae fix(application): prefer the current desktop's entry when window matches tie		1 month ago
.github/workflows	Update build.yml	5 years ago
accounts	refactor(accounts): rewrite account service integration	1 month ago
appearance	feat(appearance): expose the icon theme and its change signal	1 month ago
application	fix(application): prefer the current desktop's entry when window matches tie	1 month ago
audio	refactor(application): remove Fish style selection	1 month ago
bluetooth	feat(bluetooth): replace BluezQt with native BlueZ integration	2 months ago
cmake	feat(protocols): ship client bindings for the compositor's private protocols	1 month ago
debian	chore(debian): update package metadata	1 month ago
io	feat(io): store thumbnails in the freedesktop cache and decode cache hits once	1 month ago
media	refactor(appearance): split the library from its QML plugin	2 months ago
network	refactor(network): move NetworkManager preferences into network.conf	1 month ago
protocols	feat(protocols): ship client bindings for the compositor's private protocols	1 month ago
screen	fix(screen): report unavailability only after the first state reply	1 month ago
.gitignore	init	6 years ago
CMakeLists.txt	feat(protocols): ship client bindings for the compositor's private protocols	1 month ago
LICENSE	init	6 years ago
README.md	feat(protocols): ship client bindings for the compositor's private protocols	1 month ago

README.md

Cutefish Framework

Cutefish Framework provides shared system APIs and backend integrations for Cutefish desktop components and applications.

It provides common access to application metadata, networking, Bluetooth, audio, display, appearance, accounts, media controls, and other desktop services.

Components

The framework provides these CMake targets and C++ aliases:

cutefish-framework-application / Cutefish::Application
cutefish-framework-accounts / Cutefish::Accounts
cutefish-framework-audio / Cutefish::Audio
cutefish-framework-appearance / Cutefish::Appearance
cutefish-framework-bluetooth / Cutefish::Bluetooth
cutefish-framework-media / Cutefish::Media
cutefish-framework-network / Cutefish::Network
cutefish-framework-protocols / Cutefish::Protocols
cutefish-framework-screen / Cutefish::Screen

Cutefish::Protocols carries the client bindings for the compositor's private Wayland protocols (protocols/*.xml). That XML is kept byte-identical to cutefish-compositor/protocols; other projects link the target instead of keeping a copy.

The QML modules are Cutefish.Application, Cutefish.Accounts, Cutefish.Appearance, Cutefish.Audio, Cutefish.Bluetooth, Cutefish.Media, Cutefish.Network, and Cutefish.Screen.

The audio module uses native PipeWire with WirePlumber session policy. See audio integration and tests for details.

Dependencies

The framework uses Qt 6 and a C++20 compiler. NetworkManagerQt is the only KDE Frameworks dependency; it is used by the network module.

Debian/Ubuntu

sudo apt install cmake pkg-config build-essential \
    qt6-base-dev qt6-declarative-dev qt6-tools-dev qt6-tools-dev-tools \
    libkf6networkmanagerqt-dev bluez \
    libpipewire-0.3-dev libspa-0.2-dev pipewire wireplumber

Arch Linux

sudo pacman -S --needed base-devel cmake pkgconf \
    qt6-base qt6-declarative bluez networkmanager-qt \
    pipewire wireplumber

Build and Install

mkdir build
cd build
cmake ..
make
sudo make install

License

This project has been licensed by GPLv3.

Window presentation

Set WindowHints.skipTaskbar to exclude a window from the dock, status bar application identity, and window switcher:

import Cutefish.Application

Window {
    WindowHints.skipTaskbar: true
}