README.md

Extending Hyprland's features

Pyprland is a host process for multiple Hyprland extensions, aiming at simplicity and efficiency.

It provides a variety of plugins you can enable to your liking.

New users need to read the getting started page.

→ Documentation

→ Discussions

→ Changes history

Share your thoughts and setup bits on discuss anything

About Pyprland

🎉 "It just works very very well" - The Linux Cast (video) - February 2024

🎉 You NEED This in your Hyprland Config - LibrePhoenix (video) - October 2023 (warning: now TOML format is preferred over JSON)

Dependencies

• Hyprland >= 0.30 (versions < 1.8 can run on Hyprland 0.25)
• Python >= 3.11
• aiofiles python package (since Pyprland >= 2.0)

Latest major changes

Check the Releases change log for more information

2.0

• New dependency: aiofiles

  • fully asynchronous plugins, including file operations

• Added hysteresis support for scratchpads in 2.0.1, only active if unfocus="hide" is set.

  If it feels too slow for you, set a lower value or hysteresis=0 to completely disable it.

1.10

• New fetch_client_menu plugin (shows a menu to bring a window to the active desktop)
• Dynamic menus can be achieved by shortcuts_menu

1.9

• New shortcuts_menu plugin

1.8

• toggle_minimized command renamed to toggle_special and moved to a separate plugin for clarity

  • add the toggle_special plugin to your config and rename the command in your hyprland.conf & scripts!
  • was provided by expose

• monitors plugin improved a lot. If you were disappointed with a previous experience, give another chance to the latest 1.8 version.

• New layout_center plugin

• Automated testing have improved a lot

1.7

• BREAKING CHANGE monitors plugin uses now a new syntax - full rewrite (expect a behavior change)

Developers

If you feel like contributing, you are welcome. It can be done in many different ways:

• bug reporting or proposing solid feature requests
• Improving the wiki (catching/fixing mistakes, helping with the formal structure, additional content, better wording, etc...)
• Writing new plugins
• Improving existing plugins
• Improving test coverage

Check the creating a pull request document if you are not familiar with it

Star History