Hyprland/README.md

96 lines
3.3 KiB
Markdown
Raw Normal View History

2022-04-01 21:19:33 +02:00
<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" />
2022-04-07 21:25:19 +02:00
<a href="https://discord.gg/hQ9XvMUjjr"><img src="https://img.shields.io/badge/Join%20the-Discord%20server-6666ff" /></a>
2022-04-01 21:19:33 +02:00
<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" />
2022-04-01 21:20:03 +02:00
<img src="https://img.shields.io/github/license/vaxerski/Hyprland" />
2022-04-01 21:19:33 +02:00
<img src="https://img.shields.io/tokei/lines/github/vaxerski/Hyprland" />
<img src="https://img.shields.io/badge/Hi-mom!-ff69b4" />
</p>
2022-03-20 18:02:20 +01:00
<br/><br/>
2022-04-07 21:16:00 +02:00
People asked me to make a discord server, so <a href="https://discord.gg/hQ9XvMUjjr">join here!</a>
<br/><br/>
2022-03-20 18:02:20 +01:00
Hyprland is a Dynamic Tiling Wayland Compositor in early development stages.
2022-04-02 20:44:26 +02:00
For Hyprland without the land part, see <a href="https://github.com/vaxerski/Hypr">Hypr</a>, 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-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-03-30 22:31:04 +02:00
- Damage tracking
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-12 22:36:40 +02:00
please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation) for the installation instructions.
<br/>
2022-03-20 18:02:20 +01:00
# 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/>
2022-04-02 21:16:53 +02:00
# Contributions
Very welcome! see [Contributing.md](https://github.com/vaxerski/Hyprland/blob/main/CONTRIBUTING.md) for instuctions and guidelines!
<br/>
2022-03-20 18:02:20 +01:00
# Gallery
2022-04-09 22:50:17 +02:00
![Image1](https://i.imgur.com/ZA4Fa8R.png)
![Image2](https://i.imgur.com/BpXxM8H.png)
2022-03-20 18:02:20 +01:00
<br/>
# Stars over time
[![Stars over time](https://starchart.cc/vaxerski/Hyprland.svg)](https://starchart.cc/vaxerski/Hyprland)
2022-03-27 12:10:47 +02:00
# 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