Skip to content

Latest commit

History

History
111 lines (81 loc) 路 7.84 KB

README.md

File metadata and controls

111 lines (81 loc) 路 7.84 KB

checks codeql reuse downloads sponsors Discord docs

Kando is a highly customizable pie menu for the desktop which allows you to create your own menus and actions. For instance, you can use it to control your music player, to open your favorite websites, or to simulate shortcuts. It is available for Windows, Linux and macOS.

The Vision

I am the developer of Fly-Pie, which is a similar project but limited to the GNOME desktop. I have been working on Fly-Pie for more than 3 years now and I am very happy with the result. However, I have always wanted to create a similar application for the desktop in general. This is why I started this project.

Kando is very similar to Fly-Pie in terms of interaction and appearance. At the same time, there are some major differences. You can read more in this blog post!

Platform Support

Implementing a menu like Kando in a cross-platform manner is not exactly easy. Things like getting the mouse position before opening a window, simulating key presses, or getting the name of the currently focused application window has to be implemented differently on each platform.

For now, I have tested Kando on the following platforms:

Tested聽Environment Status Notes
聽Windows 鉁旓笍 Tested on Windows 11.
聽macOS 鉁旓笍 Tested on macOS 11.
聽GNOME聽/聽X11 鉁旓笍
聽GNOME聽/聽Wayland 鉁旓笍 Requires adapter GNOME Shell extension which provides a DBus interface for Kando to communicate with.
聽KDE聽/聽X11 鉁旓笍
聽KDE聽/聽Wayland 鉁旓笍 Uses the KWin Scripting API and the Remote-Desktop Portal to implement the required functionality. It works both on Plasma 5 and Plasma 6.
Hyprland 鉁旓笍 Uses some wlroots Wayland protocols, the hyprctl command line tool and the Hyprland Global Shortcuts protocol to implement the required functionality.
聽XFCE 鉁旓笍
聽MATE 鉁旓笍
聽Budgie 鉁旓笍
聽Cinnamon 鉁旓笍
聽LXQt 鉁旓笍
聽LXDE 鉁旓笍 Requires a compositor for the transparency to work.
聽Openbox 鉁旓笍 Requires a compositor for the transparency to work.
聽i3 鉁旓笍 Requires a compositor for the transparency to work.

馃摝 Installation

You can either 猬囷笍 download a pre-built package from the releases page or 馃殌 compile Kando yourself. With a pre-built package, you can just run the executable; no installation is required.

Important

If you are using GNOME under Wayland, you will also need to install the 馃悮 adapter extension!

Manual compilation is only required if you want to test the latest development version of the prototype or if you want to contribute to the project.

馃殌 Getting Started

For now, the prototype only comes with an example menu which does not do anything useful. However, if you want to get your hands dirty, you can already create custom menus and actions by editing the config files! This way, the prototype can do something useful already. You can read more about this in the 馃摑 documentation.

馃挒 I want to contribute!

kofi github paypal crypto

That's great! If you like the idea of Kando, you can help in many ways:

  • Discuss the idea! Tell me what you think about Kando and what features you would like to see. You can do this by opening a discussion or by joining the Discord server.
  • Spread the word! Tell your friends about Kando and share the project on social media.
  • Contribute code! If you are a developer, you can help me with the implementation. I have never worked with Electron before, so I'm sure there is a lot of room for improvement. Please read the contributing guidelines for more information!

While direct contributions are the most awesome way to support the development, donations will encourage me to invest my spare time for developing free and open-source software.

These awesome people have already donated to the development of my open-source projects:

Sponsors List

Credits

This README uses icons from Simple Icons.