hyprland-wiki/pages/Getting Started/Master-Tutorial.md

96 lines
3.8 KiB
Markdown
Raw Normal View History

2023-01-09 20:18:37 +01:00
If you are coming to Hyprland for the first time, this is the main tutorial to read.
Due to a lot of people doing stupid stuff, this tutorial will cover literally everything
you need to just get things going. It does link to other pages where necessary.
{{< toc >}}
## Install Hyprland
See [Installation](../Installation) and come back here once you have successfully
installed Hyprland.
2023-01-09 20:18:37 +01:00
Install `kitty` (default terminal emulator) terminal. This is available in most
distros' repositories.
2023-01-09 20:18:37 +01:00
## NVIDIA?
_If not using an NVIDIA card, skip this step_
Please take a look at
2023-03-05 14:43:30 +01:00
[The Nvidia page](../../Nvidia) before launching. It has a lot of info regarding the needed
environment and tweaks.
2023-01-09 20:18:37 +01:00
## VM?
_If not using a VM, skip this step_
In a VM, make sure you have 3D acceleration enabled in your virtio config (or virt-manager)
otherwise Hyprland ***will not work***.
You can also passthru a GPU to make it work.
Please bear in mind 3D accel in VMs may be pretty slow.
2023-03-05 14:18:13 +01:00
## Launching Hyprland
2023-01-09 20:18:37 +01:00
2023-03-05 14:18:13 +01:00
Now, you can just execute `Hyprland` in your tty.
2023-01-09 20:18:37 +01:00
**!IMPORTANT**: Do **not** launch Hyprland with `root` permissions (don't
`sudo`)
Login managers are not officially supported, but here's a short compatibility
list:
- SDDM → Works flawlessly. Install the [latest git version](https://github.com/sddm/sddm) (or [sddm-git](https://aur.archlinux.org/packages/sddm-git) from the AUR if you use Arch) to prevent SDDM bug [1476](https://github.com/sddm/sddm/issues/1476) (90s shutdowns).
- GDM → Works with the caveat of crashing Hyprland on the first launch
- ly → Works poorly
## In Hyprland
You're good to go with your adventure, technically.
2023-01-09 20:18:37 +01:00
Use <key>SUPER</key> + <key>Q</key> to launch kitty. If you wish to choose the
default terminal before you proceed, you can do so in `~/.config/hypr/hyprland.conf`.
2023-01-09 20:18:37 +01:00
If you want the best experience with less hassle googling, keep reading.
## Critical software
See the [Must-have Software page](../../Useful-Utilities/Must-have) for the crucial
things to make Wayland / Hyprland / other apps work correctly.
## Monitors config
See [Configuring Hyprland page](../../Configuring/Monitors) to learn all
about configuring your displays.
## Apps / X11 replacements
See the [Useful Utilities page](../../Useful-Utilities) and the
[Sway wiki page](https://github.com/swaywm/sway/wiki/Useful-add-ons-for-sway)
2023-02-03 18:52:37 +01:00
just about that. You can also visit the
[Awesome-Hyprland](https://github.com/hyprland-community/awesome-hyprland)
repository for a more comprehensive list.
2023-01-09 20:18:37 +01:00
## Fully configure
Head onto the
[Configuring Hyprland page](../../Configuring/Configuring-Hyprland) to learn all
2023-01-09 20:36:34 +01:00
about configuring Hyprland to your likings.
## Cursors
Cursors are a notorious pain to set up when you don't know how. See
[this FAQ entry](../../FAQ#how-do-i-change-me-mouse-cursor)
2023-01-17 16:25:45 +01:00
If your cursor does not appear, then see [this FAQ entry](../../FAQ#me-cursor-no-render)
2023-01-09 20:36:34 +01:00
## Themes
Since this is not a full fledged Desktop Environment, you will need to use tools such as
`lxappearance` and `nwg-look` (recommended) for GTK, and `qt5ct` / `qt6ct` for their
respective QT versions. Some older applications may also require `qt4ct`.
2023-01-09 20:39:18 +01:00
## Force apps to use Wayland
A lot of apps will use Wayland by default. Chromium (and other browsers based on it or electron)
2023-01-09 21:18:22 +01:00
don't. You need to pass `--enable-features=UseOzonePlatform --ozone-platform=wayland` to them or use `.conf` files
2023-02-13 11:05:01 +01:00
where possible. Chromium-based browsers also should have a toggle in `chrome://flags`. Search for _"ozone"_ and select Wayland.
2023-01-09 21:18:22 +01:00
For most electron apps, you should put the above in `~/.config/electron-flags.conf`. VSCode is known
to not work with that though.
2023-03-26 20:52:25 +02:00
A few more environment variables for forcing Wayland mode are documented [here](../../Configuring/Environment-variables).
You can check whether an app is running in xwayland or not with `hyprctl clients`.