Hyprland/README.md

148 lines
4.3 KiB
Markdown
Raw Permalink Normal View History

2022-04-18 23:00:16 +02:00
<div align = center>
2022-04-18 22:08:57 +02:00
2022-07-18 14:19:21 +02:00
<img src="https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/header.svg" width="750" height="300" alt="banner">
2022-04-18 22:08:57 +02:00
2022-04-18 23:00:16 +02:00
<br>
2022-04-19 13:38:08 +02:00
![Badge Workflow]
[![Badge License]][License]
![Badge Language]
[![Badge Pull Requests]][Pull Requests]
[![Badge Issues]][Issues]
![Badge Hi Mom]<br>
2022-04-19 11:17:45 +02:00
[![Badge Discord]][Discord]
2022-04-19 13:38:08 +02:00
2022-04-18 23:00:16 +02:00
<br>
2022-04-19 11:17:45 +02:00
Hyprland is a dynamic tiling Wayland compositor based on wlroots that doesn't sacrifice on its looks.
2022-04-18 22:08:57 +02:00
2023-09-02 00:20:20 +02:00
It provides the latest Wayland features, is highly customizable, has all the eyecandy, the most powerful plugins,
easy IPC, much more QoL stuff than other wlr-based compositors and more...
2022-04-18 23:00:16 +02:00
<br>
<br>
2022-04-18 22:08:57 +02:00
2022-04-18 23:02:59 +02:00
---
2022-04-18 23:34:52 +02:00
**[<kbd><br>Install<br></kbd>][Install]**
2022-04-21 18:43:58 +02:00
**[<kbd><br>Quick Start<br></kbd>][Quick Start]**
2022-04-18 23:06:58 +02:00
**[<kbd><br>Configure<br></kbd>][Configure]**
**[<kbd><br>Contribute<br></kbd>][Contribute]**
2022-03-16 20:50:55 +01:00
2022-04-18 23:21:58 +02:00
---
2022-04-18 23:42:57 +02:00
<br>
2022-04-18 23:42:04 +02:00
2022-04-19 11:17:45 +02:00
</div>
2022-04-29 21:43:04 +02:00
2022-04-18 23:21:58 +02:00
# Features
2022-04-19 13:38:08 +02:00
2023-09-02 00:20:20 +02:00
- All of the eyecandy: gradient borders, blur, animations, shadows and much more
- A lot of customization
- Much more QoL stuff than other wlr-based compositors
- Custom bezier curves for the best animations
- Powerful plugin support
- Built-in plugin manager
2023-09-28 23:09:10 +02:00
- Tearing support for better gaming performance
2022-04-18 23:21:58 +02:00
- Easily expandable and readable codebase
2023-09-02 00:20:20 +02:00
- Fast and active development
- Not scared to provide bleeding-edge features
2022-04-18 23:21:58 +02:00
- Config reloaded instantly upon saving
2022-05-31 14:15:28 +02:00
- Fully dynamic workspaces
2023-09-02 00:20:20 +02:00
- Two built-in layouts and more available as plugins
2022-06-09 21:59:30 +02:00
- Closely follows `wlroots-git`
2022-07-26 17:34:53 +02:00
- Global keybinds passed to your apps of choice
2022-06-09 21:59:30 +02:00
- Tiling/pseudotiling/floating/fullscreen windows
2022-11-30 23:49:47 +01:00
- Special workspaces (scratchpads)
2023-09-02 00:20:20 +02:00
- Window groups (tabbed mode)
- Powerful window/monitor/layer rules
2022-04-19 11:17:45 +02:00
- Socket-based IPC
2023-09-02 00:20:20 +02:00
- Native IME and Input Panels Support
2022-07-26 17:34:53 +02:00
- and much more...
2022-03-20 18:02:20 +01:00
2022-04-18 23:36:58 +02:00
<br>
<br>
2022-04-02 21:16:53 +02:00
2022-04-18 22:24:23 +02:00
<div align = center>
2022-04-18 23:36:58 +02:00
# Gallery
2022-04-18 23:30:24 +02:00
2022-04-18 23:32:51 +02:00
<br>
2022-04-18 22:08:57 +02:00
![Preview A]
2022-03-20 18:02:20 +01:00
2022-04-18 22:24:23 +02:00
<br>
2022-04-18 23:32:51 +02:00
![Preview B]
2022-04-18 22:24:23 +02:00
2022-05-15 18:31:30 +02:00
<br>
![Preview C]
2022-04-18 23:32:51 +02:00
<br>
2022-04-18 22:24:23 +02:00
<br>
</div>
2022-04-18 23:36:58 +02:00
# Special Thanks
2022-04-18 23:30:24 +02:00
<br>
2022-04-19 11:17:45 +02:00
**[wlroots]** - *For their amazing library*
2022-03-27 12:11:01 +02:00
2022-04-19 11:17:45 +02:00
**[tinywl]** - *For showing how 2 do stuff*
2022-03-27 12:11:01 +02:00
2022-04-19 11:17:45 +02:00
**[Sway]** - *For showing how 2 do stuff the overkill way*
2022-04-18 23:30:24 +02:00
2022-04-19 11:17:45 +02:00
**[Vivarium]** - *For showing how 2 do stuff the simple way*
2022-04-18 23:30:24 +02:00
2022-04-19 11:17:45 +02:00
**[dwl]** - *For showing how 2 do stuff the hacky way*
2022-04-18 23:30:24 +02:00
2022-04-19 11:17:45 +02:00
**[Wayfire]** - *For showing how 2 do some graphics stuff*
2022-04-18 22:08:57 +02:00
<!----------------------------------------------------------------------------->
2022-08-19 21:50:57 +02:00
[Configure]: https://wiki.hyprland.org/Configuring/Configuring-Hyprland/
2022-04-18 22:08:57 +02:00
[Discord]: https://discord.gg/hQ9XvMUjjr
2022-07-13 20:23:43 +02:00
[Stars]: https://starchart.cc/hyprwm/Hyprland
[Hypr]: https://github.com/hyprwm/Hypr
2022-04-18 22:08:57 +02:00
2022-07-13 20:23:43 +02:00
[Pull Requests]: https://github.com/hyprwm/Hyprland/pulls
[Issues]: https://github.com/hyprwm/Hyprland/issues
[Todo]: https://github.com/hyprwm/Hyprland/projects?type=beta
2022-04-18 23:08:55 +02:00
2022-08-19 21:50:57 +02:00
[Contribute]: https://wiki.hyprland.org/Contributing-and-Debugging/
[Install]: https://wiki.hyprland.org/Getting-Started/Installation/
2023-02-14 21:28:33 +01:00
[Quick Start]: https://wiki.hyprland.org/Getting-Started/Master-Tutorial/
2022-04-18 23:08:55 +02:00
[License]: LICENSE
2022-04-18 22:08:57 +02:00
2022-04-18 23:30:24 +02:00
<!----------------------------------{ 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://codeberg.org/dwl/dwl
2022-04-18 23:30:24 +02:00
2022-04-18 22:08:57 +02:00
<!----------------------------------{ Images }--------------------------------->
[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg
2023-11-14 21:08:00 +01:00
[Preview A]: https://i.ibb.co/C1yTb0r/falf.png
[Preview B]: https://cdn.discordapp.com/attachments/1091569872535814185/1107675866101723277/screenshot-summer.png
2023-05-15 16:30:17 +02:00
[Preview C]: https://i.ibb.co/B3GJg28/20221126-20h53m26s-grim.png
2022-04-18 22:08:57 +02:00
<!----------------------------------{ Badges }--------------------------------->
2022-07-13 20:23:43 +02:00
[Badge Workflow]: https://github.com/hyprwm/Hyprland/actions/workflows/ci.yaml/badge.svg
2022-04-18 23:00:16 +02:00
2022-04-19 11:17:45 +02:00
[Badge Discord]: https://img.shields.io/badge/Join%20the-Discord%20server-6666ff
2022-07-13 20:23:43 +02:00
[Badge Issues]: https://img.shields.io/github/issues/hyprwm/Hyprland
[Badge Pull Requests]: https://img.shields.io/github/issues-pr/hyprwm/Hyprland
[Badge Language]: https://img.shields.io/github/languages/top/hyprwm/Hyprland
[Badge License]: https://img.shields.io/github/license/hyprwm/Hyprland
[Badge Lines]: https://img.shields.io/tokei/lines/github/hyprwm/Hyprland
2022-04-19 11:17:45 +02:00
[Badge Hi Mom]: https://img.shields.io/badge/Hi-mom!-ff69b4