Skip to content

winft/kdisplay

Repository files navigation

KDisplay

KDisplay is a small display management app. It provides a simple and straightforward UI for managing an arbitrary number of displays.

KDisplay in Theseus' Ship Wayland session

Features

  • Displays can be repositioned with drag-and-drop.
  • An optimal resolution and refresh rate are automatically selected. Manual override is possible.
  • Displays can be seemlessly "replicated".
  • The settings of a display is by default remembered globally but can be overridden for specific combinations of displays.
  • Provides additional integration for the KDE Plasma Workspace through a plasmoid and an OSD activated by hardware key for quick configuration changes.

Installation

Requirements

KDisplay works with many windowing system and compositors:

  • Any X11 desktop
  • Wayland:
    • Theseus' Ship and other The Compositor Modules based compositors
    • sway and other wlroots based compositors

Packages

Your distribution might provide KDisplay already as a package:

Compile from source

KDisplay can also be compiled from source with following dependencies:

  • Extra CMake Modules
  • Qt
  • Disman
  • KDBusAddons
  • KDeclarative
  • KI18n
  • Kirigami

Configure, build and install KDisplay like any other CMake based project. You can install it to your normal system directory. This will also ensure certain service files for integration with the KDE Plasma workspace will be picked up correctly.

Usage

App

Just run kdisplay from command line or look for the "Displays" entry in the launcher that your desktop environment provides.

KDE Plasma integration

On laptops the OSD can be activated by hardware key. The plasmoid is available in the systems tray.

Reporting issues

See first the respective section in Disman's Readme. In case KDisplay is identified as being responsible for the issue you experience and no issue ticket exists yet for this specific issue please create a new ticket.

Translations

KDisplay has been translated to the following languages already:

Translation status

We use the Weblate service for localization. If you want to help us translating KDisplay to your native or other languages please join us there.

Contributing

If you are interested in improving the KDisplay source code directly, see the CONTRIBUTING.md file on how to get started.

Contact

Issue tickets can be created for feature requests, bug reports or general discussions. For direct communication join The Compositor Modules Matrix room.