Hyprland/README.md
2022-04-14 18:18:37 +02:00

96 lines
3.3 KiB
Markdown

<p align="center">
<img src="https://raw.githubusercontent.com/vaxerski/Hyprland/main/assets/hyprland.png" />
<br/><br/>
<img src="https://github.com/vaxerski/Hyprland/actions/workflows/ci.yaml/badge.svg" />
<a href="https://discord.gg/hQ9XvMUjjr"><img src="https://img.shields.io/badge/Join%20the-Discord%20server-6666ff" /></a>
<img src="https://img.shields.io/github/issues/vaxerski/Hyprland" />
<img src="https://img.shields.io/github/issues-pr/vaxerski/Hyprland" />
<img src="https://img.shields.io/github/languages/top/vaxerski/Hyprland" />
<img src="https://img.shields.io/github/license/vaxerski/Hyprland" />
<img src="https://img.shields.io/tokei/lines/github/vaxerski/Hyprland" />
<img src="https://img.shields.io/badge/Hi-mom!-ff69b4" />
</p>
<br/><br/>
People asked me to make a discord server, so <a href="https://discord.gg/hQ9XvMUjjr">join here!</a>
<br/><br/>
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
For Hyprland without the land part, see <a href="https://github.com/vaxerski/Hypr">Hypr</a>, the Xorg window manager.
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!
# Key features
- Parabolic window animations
- Config reloaded instantly upon saving
- Easily expandable and readable codebase
- Rounded corners
- Window blur
- Workspaces Protocol support
- Fade in/out
- Support for docks/whatever
- Window rules
- Monitor rules
- Socket-based IPC
- Tiling/floating/fullscreen windows
- Moving/resizing windows
# Major to-dos
- Damage tracking
- Input Methods (wlr_input_method_v2)
- Animations (some new, like workspace)
- Fix electron rendering issues
- Optimization
- Fix weird scroll on XWayland (if possible)
- Become sane
- STABILITY
- More config options for tweakers
- Improve hyprctl
# Installation
I do not maintain any packages, but some kind people have made them for me. If I missed any, please let me know.
**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.
_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,
please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation) for the installation instructions.
<br/>
# Configuring
Head onto the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Configuring-Hyprland) to see more.
Hyprland without a config is a bad idea!
<br/>
# Contributions
Very welcome! see [Contributing.md](https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md) for instuctions and guidelines!
<br/>
# Gallery
![Image1](https://i.imgur.com/ZA4Fa8R.png)
![Image2](https://i.imgur.com/BpXxM8H.png)
<br/>
# Stars over time
[![Stars over time](https://starchart.cc/vaxerski/Hyprland.svg)](https://starchart.cc/vaxerski/Hyprland)
# Special thanks
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