mirror of
https://github.com/hyprwm/hyprland-wiki.git
synced 2024-12-02 00:45:58 +01:00
147 lines
5.3 KiB
Markdown
147 lines
5.3 KiB
Markdown
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.
|
|
|
|
Install `kitty` (default terminal emulator) terminal. This is available in most
|
|
distros' repositories.
|
|
|
|
## NVIDIA?
|
|
_If not using an NVIDIA card, skip this step_
|
|
|
|
Please take a look at
|
|
[The Nvidia page](../../Nvidia) before launching. You should **first** make a
|
|
wrapper, as described in a section a bit below, then follow the instructions from
|
|
the Nvidia page, and then continue on with sections below.
|
|
|
|
## 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.
|
|
|
|
## Launching Hyprland, part 1
|
|
We recommend you set up a wrapper. A wrapper will be your executable to launch
|
|
Hyprland with envvars.
|
|
|
|
Make an executable file somewhere in your `PATH`, for example `~/.local/bin/`,
|
|
called (for example) `wrappedhl`.
|
|
|
|
In it, put:
|
|
|
|
```bash
|
|
#!/bin/sh
|
|
|
|
cd ~
|
|
|
|
# Log WLR errors and logs to the hyprland log. Recommended
|
|
export HYPRLAND_LOG_WLR=1
|
|
|
|
# Tell XWayland to use a cursor theme
|
|
export XCURSOR_THEME=Bibata-Modern-Classic
|
|
|
|
# Set a cursor size
|
|
export XCURSOR_SIZE=24
|
|
|
|
# Example IME Support: fcitx
|
|
export GTK_IM_MODULE=fcitx
|
|
export QT_IM_MODULE=fcitx
|
|
export XMODIFIERS=@im=fcitx
|
|
export SDL_IM_MODULE=fcitx
|
|
export GLFW_IM_MODULE=ibus
|
|
|
|
exec Hyprland
|
|
```
|
|
|
|
You can add as many exported envvars as you need (Nvidia users might need a
|
|
lot)
|
|
|
|
The shown envvars are examples.
|
|
|
|
You should now launch Hyprland with `wrappedhl` instead of `Hyprland`. Make sure
|
|
to copy your `.desktop` file in `/usr/share/wayland-sessions/` and edit it if you use a
|
|
login manager! You might need to put the full path in it, as login managers are
|
|
usually not ran through the user account.
|
|
|
|
{{< hint type=important >}}
|
|
Hyprland, by default on most distros, will place `hyprland.desktop` inside
|
|
`/usr/share/wayland-sessions`. Login managers generally pick this file up and add
|
|
a session to their settings. It is highly recommended to make a copy of this
|
|
desktop file and name it something like `hyprland-wrapped.desktop` The new desktop
|
|
file will also be picked up by login managers, and provide you an extra session with
|
|
the environment variables applied to your session.
|
|
{{< /hint >}}
|
|
|
|
## Launching Hyprland, part 2
|
|
|
|
Now, with your wrapper, you can just execute it in your tty.
|
|
|
|
**!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.
|
|
|
|
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`.
|
|
|
|
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)
|
|
just about that. You can also visit the
|
|
[Awesome-Hyprland](https://github.com/hyprland-community/awesome-hyprland)
|
|
repository for a more comprehensive list.
|
|
|
|
## Fully configure
|
|
Head onto the
|
|
[Configuring Hyprland page](../../Configuring/Configuring-Hyprland) to learn all
|
|
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)
|
|
|
|
If your cursor does not appear, then see [this FAQ entry](../../FAQ#me-cursor-no-render)
|
|
|
|
## 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`.
|
|
|
|
|
|
## Force apps to use Wayland
|
|
A lot of apps will use Wayland by default. Chromium (and other browsers based on it or electron)
|
|
don't. You need to pass `--enable-features=UseOzonePlatform --ozone-platform=wayland` to them or use `.conf` files
|
|
where possible. Chromium-based browsers also should have a toggle in `chrome://flags`. Search for _"ozone"_ and select Wayland.
|
|
|
|
For most electron apps, you should put the above in `~/.config/electron-flags.conf`. VSCode is known
|
|
to not work with that though.
|
|
|
|
You can check whether an app is running in xwayland or not with `hyprctl clients`.
|