Skip to content

ClearStaff/kando

 
 

Repository files navigation

checks codeql reuse downloads sponsors Discord docs

What is Kando?

Kando is a cross-platform pie menu for your desktop. It offers an unconventional, fast, highly efficient, and fun way of interacting with your computer! You can use Kando to launch applications, simulate keyboard shortcuts, open files, and much more.

Kando is designed to be used with 🖱️ mouse, 🖊️ stylus, or 👆 touch input. If you have both hands at your keyboard most of the time, Kando is maybe not the right tool for you.

You are welcome to join the 💬 Discord server to discuss the project, ask questions, or just to hang out with other Kando enthusiasts!

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 ✔️ Works both on Plasma 5 and Plasma 6. See platform-specific notes for some details.
Hyprland ✔️ See platform-specific notes for some details.
 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

Kando comes with an example menu which you can open by pressing Ctrl+Space on most platforms. This is great to get a first impression! To learn some basics about the interaction with Kando, you can have a look at the 📝 documentation.

Once you are familiar with the basics, you can start creating your own menus. There is some basic documentation on how to create your own menus in the 📝 documentation as well!

💞 I want to contribute!

I am creating Kando out of sheer passion. It is completely free, and I am not planning to monetize it in any way. But I would be very happy if you could support the project with creative ideas, code contributions, or by sharing it with your friends and followers! 💖

kofi github paypal crypto

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.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 77.1%
  • SCSS 10.0%
  • C++ 7.0%
  • Handlebars 3.8%
  • Objective-C++ 1.1%
  • CMake 0.7%
  • Other 0.3%