Hyprwhichkey

Which-Key for Hyprland

Note

Hyprwhichkey was inspired by the eww which-key example of the Hyprhook plugin. However, since I am not familiar with the Yuck programming language, I found it difficult to make tiny adjustments. To address this, I created Hyprwhichkey using TypeScript with ags (Astal) for better flexibility and ease of use.

---

Table of Contents

1. Prerequisites
2. Installation
3. Usage
4. Showcase
5. Contributing
6. License

---

Prerequisites

Ensure you have ags v2 installed before proceeding.

---

Installation

1. Clone the repository:

   git clone https://github.com/Juhan280/hyprwhichkey.git && cd hyprwhichkey

2. Bundle the application:

   ags bundle src/app.ts /path/to/bundle/file

3. Add the script to start at system boot:

   exec-once = gjs -m /path/to/bundle/file

4. Configure keybind and blur:

   bindd = SUPER, F1, Toggle Binds Help, exec, astal -i hyprwhichkey
   
   # For blurring background of hyprwhichkey
   # Make sure to enable blur in decoration
   layerrule = blur, hyprwhichkey

---

Usage

Keybinds won't appear unless you add the description flag using bindd. However, you can leave the description empty while setting the flag, and it will automatically fall back to displaying the dispatcher instead.

---

Showcase

---

Contributing

We welcome contributions! To get started:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature-name).
3. Commit your changes (git commit -m 'Add feature').
4. Push to the branch (git push origin feature-name).
5. Create a Pull Request.

---

License

This project is licensed under the MIT License. See LICENSE.txt for details.