README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

<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.


WARNING! 
Hyprland is in early dev, expect bugs, instabilities and crashes. You have been warned!
Nevertheless, REPORT any you find! Make an issue!

# Key features
 - Basic window animations
 - Config reloaded instantly upon saving
 - Easily expandable and readable codebase
 - Rounded corners
 - Window blur
 - 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
 - Animations (better)
 - Fix GDK popups on multimon
 - Fix electron rendering issues
 - Optimization
 - Fix weird scroll on XWayland
 - Become sane
 - STABILITY
 - More config options for tweakers
 - Improve hyprctl

# Installation
Please refer to the [Wiki Page](https://github.com/vaxerski/Hyprland/wiki/Installation)
<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/>

# Special thanks
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 custom rendering