Hyprland/README.md

156 lines
4.2 KiB
Markdown
Raw Normal View History

2022-04-18 23:00:16 +02:00
![Badge Workflow]
<div align = center>
2022-04-18 22:08:57 +02:00
![Banner]
2022-04-18 23:00:16 +02:00
<br>
<br>
![Badge License]![Badge Lines]![Badge Language] <br>
![Badge Pull Requests]![Badge Issues]
<br>
2022-04-18 22:08:57 +02:00
[![Badge Discord]][Discord]
2022-04-18 23:00:16 +02:00
</div>
<br>
<br>
2022-04-18 22:08:57 +02:00
People asked me to make a discord server, so [join here!][Discord]
2022-04-18 23:00:16 +02:00
<br>
<br>
2022-04-18 22:08:57 +02:00
2022-03-20 18:02:20 +01:00
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
2022-04-18 22:08:57 +02:00
For Hyprland without the land part, see [Hypr], the Xorg window manager.
2022-03-16 20:50:55 +01:00
2022-04-13 18:44:52 +02:00
Hyprland is in early dev, expect some bugs. However, once you get it working, it's pretty stable. :P
Hyprland needs testers! Try it out and report bugs or suggestions!
2022-03-20 18:02:20 +01:00
# Key features
- Parabolic window animations
2022-03-20 18:02:20 +01:00
- Config reloaded instantly upon saving
- Easily expandable and readable codebase
2022-04-05 16:47:03 +02:00
- Rounded corners
2022-04-09 16:51:08 +02:00
- Window blur
- Workspaces Protocol support
2022-04-17 11:51:55 +02:00
- Damage tracking (experimental)
2022-04-05 20:49:15 +02:00
- Fade in/out
2022-03-20 18:02:20 +01:00
- Support for docks/whatever
2022-03-24 18:22:01 +01:00
- Window rules
2022-03-20 18:02:20 +01:00
- Monitor rules
2022-03-21 19:18:33 +01:00
- Socket-based IPC
- Tiling/floating/fullscreen windows
2022-03-20 18:02:20 +01:00
- Moving/resizing windows
# Major to-dos
2022-04-12 21:27:49 +02:00
- Input Methods (wlr_input_method_v2)
- Animations (some new, like workspace)
2022-03-20 20:26:06 +01:00
- Fix electron rendering issues
- Optimization
- Fix weird scroll on XWayland (if possible)
2022-03-20 20:26:06 +01:00
- Become sane
2022-03-20 18:02:20 +01:00
- STABILITY
2022-03-20 20:26:06 +01:00
- More config options for tweakers
- Improve hyprctl
2022-03-20 18:02:20 +01:00
# Installation
2022-04-12 22:36:40 +02:00
I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know.
2022-04-14 18:18:37 +02:00
**Warning:** since I am not the maintainer, I cannot guarantee that those packages will always work and be up to date. Use at your own disclosure. If they don't, try building manually.
2022-04-12 22:36:40 +02:00
_Arch (AUR, -git)_
```
yay -S hyprland-git
```
## Manual building
If your distro doesn't have Hyprland in its repositories, or you want to modify Hyprland,
2022-03-20 18:02:20 +01:00
2022-04-18 22:08:57 +02:00
please refer to the [Wiki Page][Install] for the installation instructions.
2022-04-12 22:36:40 +02:00
<br/>
2022-03-20 18:02:20 +01:00
# Configuring
2022-04-18 22:08:57 +02:00
Head onto the [Wiki Page][Configure] to see more.
2022-03-20 18:02:20 +01:00
Hyprland without a config is a bad idea!
<br/>
2022-04-02 21:16:53 +02:00
# Contributions
2022-04-18 22:08:57 +02:00
Very welcome! see [Contributing.md][Contribute] for instuctions and guidelines!
2022-04-02 21:16:53 +02:00
<br/>
2022-04-18 22:24:23 +02:00
<div align = center>
2022-03-20 18:02:20 +01:00
# Gallery
2022-04-18 22:08:57 +02:00
![Preview A]
![Preview B]
2022-03-20 18:02:20 +01:00
2022-04-18 22:24:23 +02:00
<br>
---
<br>
# Stars Over Time
2022-04-18 22:08:57 +02:00
[![Stars Preview]][Stars]
2022-04-18 22:24:23 +02:00
<br>
---
<br>
</div>
# Special Thanks
wlroots - for their amazing library
2022-03-27 12:10:47 +02:00
tinywl - for showing how 2 do stuff
2022-03-27 12:11:01 +02:00
2022-03-27 12:10:47 +02:00
sway - for showing how 2 do stuff the overkill way
2022-03-27 12:11:01 +02:00
2022-03-27 12:10:47 +02:00
vivarium - for showing how 2 do stuff the simple way
2022-03-27 12:11:01 +02:00
2022-03-27 12:10:47 +02:00
dwl - for showing how 2 do stuff the hacky way
2022-03-27 12:11:01 +02:00
wayfire - for showing how 2 do some graphics stuff
2022-04-18 22:08:57 +02:00
<!----------------------------------------------------------------------------->
[Contribute]: https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md
[Configure]: https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland
[Install]: https://github.com/vaxerski/Hyprland/wiki/Installation
[Discord]: https://discord.gg/hQ9XvMUjjr
[Stars]: https://starchart.cc/vaxerski/Hyprland
[Hypr]: https://github.com/vaxerski/Hypr
<!----------------------------------{ Images }--------------------------------->
[Stars Preview]: https://starchart.cc/vaxerski/Hyprland.svg
[Preview A]: https://i.imgur.com/ZA4Fa8R.png
[Preview B]: 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
2022-04-18 23:00:16 +02:00
[Badge Discord]: https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white
[Badge Issues]: https://img.shields.io/github/issues/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a9%ef%bd%93%ef%bd%93%ef%bd%95%ef%bd%85%ef%bd%93
[Badge Pull Requests]: https://img.shields.io/github/issues-pr/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%b0%ef%bd%95%ef%bd%8c%ef%bd%8c%20%ef%bc%b2%ef%bd%85%ef%bd%91%ef%bd%95%ef%bd%85%ef%bd%93%ef%bd%94%ef%bd%93
[Badge Language]: https://img.shields.io/github/languages/top/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bc%8b%ef%bc%8b
[Badge License]: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge&label=%ef%bc%ac%ef%bd%89%ef%bd%83%ef%bd%85%ef%bd%8e%ef%bd%93%ef%bd%85
[Badge Lines]: https://img.shields.io/tokei/lines/github/vaxerski/Hyprland?style=for-the-badge&label=%ef%bc%a3%ef%bd%8f%ef%bd%84%ef%bd%85