mirror of
https://github.com/hyprwm/Hyprland
synced 2024-11-05 08:45:59 +01:00
167 lines
4.3 KiB
Markdown
167 lines
4.3 KiB
Markdown
<div align = center>
|
||
|
||
![Banner]
|
||
|
||
<br>
|
||
|
||
![Badge Workflow]
|
||
[![Badge License]][License]
|
||
![Badge Lines]
|
||
![Badge Language]
|
||
[![Badge Pull Requests]][Pull Requests]
|
||
[![Badge Issues]][Issues]
|
||
![Badge Hi Mom]<br>
|
||
[![Badge Discord]][Discord]
|
||
|
||
<br>
|
||
|
||
Hyprland is a dynamic tiling Wayland compositor based on wlroots that doesn't sacrifice on its looks.
|
||
|
||
For Hyprland without the `land` part, see [Hypr], the Xorg window manager.
|
||
|
||
Please note, especially for folks moving from Hypr, that Hyprland and Hypr share a very different feature set and are not 1:1 experiences.
|
||
<br>
|
||
<br>
|
||
|
||
---
|
||
|
||
**[<kbd> <br> Install <br> </kbd>][Install]**
|
||
**[<kbd> <br> Quick Start <br> </kbd>][Quick Start]**
|
||
**[<kbd> <br> Configure <br> </kbd>][Configure]**
|
||
**[<kbd> <br> Contribute <br> </kbd>][Contribute]**
|
||
|
||
---
|
||
|
||
<br>
|
||
|
||
</div>
|
||
|
||
# Notice
|
||
|
||
Hyprland is still in pretty early development compared to some other Wayland compositors.
|
||
|
||
Although Hyprland is pretty stable, it may have some bugs.
|
||
|
||
### Help Wanted
|
||
|
||
Hyprland needs testers! <br/>
|
||
Try it out and report bugs / suggestions!
|
||
|
||
# Features
|
||
|
||
- Easily expandable and readable codebase
|
||
- Config reloaded instantly upon saving
|
||
- Custom bezier curve based animations
|
||
- `wlr_ext` workspaces protocol support
|
||
- Dual Kawase blur
|
||
- Fully dynamic workspaces
|
||
- Closely follows `wlroots-git`
|
||
- Bundled wlroots
|
||
- Window/layer fade in/out
|
||
- Tiling/pseudotiling/floating/fullscreen windows
|
||
- Switching workspaces between window modes on the fly
|
||
- Special workspace (scratchpad)
|
||
- Window/monitor rules
|
||
- Socket-based IPC
|
||
- Event system for bash scripts
|
||
- Rounded corners
|
||
- Full damage tracking
|
||
- Docks support
|
||
- Drawing tablet support
|
||
|
||
<br>
|
||
<br>
|
||
|
||
<div align = center>
|
||
|
||
# Gallery
|
||
|
||
<br>
|
||
|
||
![Preview A]
|
||
|
||
<br>
|
||
|
||
![Preview B]
|
||
|
||
<br>
|
||
|
||
![Preview C]
|
||
|
||
<br>
|
||
<br>
|
||
|
||
# Stars Over Time
|
||
|
||
<br>
|
||
|
||
[![Stars Preview]][Stars]
|
||
|
||
<br>
|
||
<br>
|
||
|
||
</div>
|
||
|
||
# Special Thanks
|
||
|
||
<br>
|
||
|
||
**[wlroots]** - *For their amazing library*
|
||
|
||
**[tinywl]** - *For showing how 2 do stuff*
|
||
|
||
**[Sway]** - *For showing how 2 do stuff the overkill way*
|
||
|
||
**[Vivarium]** - *For showing how 2 do stuff the simple way*
|
||
|
||
**[dwl]** - *For showing how 2 do stuff the hacky way*
|
||
|
||
**[Wayfire]** - *For showing how 2 do some graphics stuff*
|
||
|
||
|
||
<!----------------------------------------------------------------------------->
|
||
|
||
[Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland
|
||
[Discord]: https://discord.gg/hQ9XvMUjjr
|
||
[Stars]: https://starchart.cc/vaxerski/Hyprland
|
||
[Hypr]: https://github.com/vaxerski/Hypr
|
||
|
||
[Pull Requests]: https://github.com/vaxerski/Hyprland/pulls
|
||
[Issues]: https://github.com/vaxerski/Hyprland/issues
|
||
[Todo]: https://github.com/vaxerski/Hyprland/projects?type=beta
|
||
|
||
[Contribute]: https://github.com/vaxerski/Hyprland/wiki/Contributing-&-Debugging
|
||
[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation
|
||
[Quick Start]: https://github.com/vaxerski/Hyprland/wiki/Quick-start
|
||
[License]: LICENSE
|
||
|
||
|
||
<!----------------------------------{ Thanks }--------------------------------->
|
||
|
||
[Vivarium]: https://github.com/inclement/vivarium
|
||
[WlRoots]: https://gitlab.freedesktop.org/wlroots/wlroots
|
||
[Wayfire]: https://github.com/WayfireWM/wayfire
|
||
[TinyWl]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/tinywl/tinywl.c
|
||
[Sway]: https://github.com/swaywm/sway
|
||
[DWL]: https://github.com/djpohly/dwl
|
||
|
||
<!----------------------------------{ Images }--------------------------------->
|
||
|
||
[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg
|
||
[Preview A]: https://i.imgur.com/NbrTnZH.png
|
||
[Preview B]: https://i.imgur.com/ZA4Fa8R.png
|
||
[Preview C]: https://i.imgur.com/BpXxM8H.png
|
||
[Banner]: https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/hyprland.png
|
||
|
||
|
||
<!----------------------------------{ Badges }--------------------------------->
|
||
|
||
[Badge Workflow]: https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg
|
||
|
||
[Badge Discord]: https://img.shields.io/badge/Join%20the-Discord%20server-6666ff
|
||
[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland
|
||
[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland
|
||
[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland
|
||
[Badge License]: https://img.shields.io/github/license/vaxerski/Hyprland
|
||
[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland
|
||
[Badge Hi Mom]: https://img.shields.io/badge/Hi-mom!-ff69b4
|