2024-02-20 21:16:07 +01:00
|
|
|
---
|
|
|
|
weight: 1
|
|
|
|
title: Configuring Hyprland
|
|
|
|
---
|
|
|
|
|
2022-08-12 20:46:36 +02:00
|
|
|
The config is located in `~/.config/hypr/hyprland.conf`.
|
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
You can tell Hyprland to use a specific configuration file by using the
|
|
|
|
`--config` (or `-c`) argument.
|
2024-02-29 22:22:40 +01:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
Hyprland will automatically generate an example config for you if you don't have
|
|
|
|
one. You can find an example config
|
|
|
|
[here](https://github.com/hyprwm/Hyprland/blob/main/example/hyprland.conf).
|
2022-08-12 20:46:36 +02:00
|
|
|
|
|
|
|
By removing the line `autogenerated=1` you'll remove the yellow warning.
|
|
|
|
|
2024-04-21 16:35:48 +02:00
|
|
|
The config is reloaded the moment you save it. However, you can use `hyprctl reload` to reload the config manually.
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2022-10-23 16:35:39 +02:00
|
|
|
Start a section with `name {` and end in `}` **_in separate lines!_**
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
{{< callout >}}
|
|
|
|
|
|
|
|
The default config is not complete and does not list all the options / features
|
|
|
|
of Hyprland. Please refer to this wiki page and the pages linked further down
|
|
|
|
here for full configuration instructions.
|
|
|
|
|
2024-03-17 13:44:39 +01:00
|
|
|
**Make sure to read the [Variables](../Variables) page as well**. It covers all
|
2024-02-20 21:16:07 +01:00
|
|
|
the toggleable / numerical options.
|
2022-09-05 13:35:21 +02:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
{{< /callout >}}
|
2022-09-05 13:35:21 +02:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
## Line style
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2022-10-23 16:35:39 +02:00
|
|
|
Every config line is a command followed by a value.
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2022-09-24 16:03:37 +02:00
|
|
|
```ini
|
2022-08-12 20:46:36 +02:00
|
|
|
COMMAND=VALUE
|
|
|
|
```
|
|
|
|
|
|
|
|
The command can be a variable, or a special keyword (described further in this
|
|
|
|
page)
|
|
|
|
|
|
|
|
You are **allowed to** input trailing spaces at the beginning and end.
|
|
|
|
|
|
|
|
e.g.:
|
|
|
|
|
2022-09-24 16:03:37 +02:00
|
|
|
```ini
|
2022-08-12 20:46:36 +02:00
|
|
|
COMMAND = VALUE
|
|
|
|
```
|
|
|
|
|
|
|
|
is valid.
|
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
### Comments
|
2022-10-25 15:34:01 +02:00
|
|
|
|
|
|
|
Comments are started with the `#` character.
|
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
If you want to escape it (put an actual `#` and not start a comment) you can use
|
|
|
|
`##`. It will be turned into a single `#` that WILL be a part of your line.
|
2022-10-25 15:34:01 +02:00
|
|
|
|
2024-04-23 19:03:46 +02:00
|
|
|
### Escaping errors
|
|
|
|
|
|
|
|
If you use plugins, you may want to ignore errors from missing options/keywords
|
|
|
|
so that you don't get an error bar before they are loaded. To do so, do this:
|
|
|
|
|
|
|
|
```ini
|
|
|
|
# hyprlang noerror true
|
|
|
|
|
|
|
|
bind = MOD, KEY, something, amogus
|
|
|
|
someoption = blah
|
|
|
|
|
|
|
|
# hyprlang noerror false
|
|
|
|
```
|
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
## Basic configuring
|
2022-08-12 20:46:36 +02:00
|
|
|
|
|
|
|
To configure the "options" of Hyprland, animations, styling, etc. see
|
2024-03-17 13:44:39 +01:00
|
|
|
[Variables](../Variables).
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
## Advanced configuring
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2024-02-20 21:16:07 +01:00
|
|
|
Some keywords (binds, curves, execs, monitors, etc.) are not variables but
|
|
|
|
define special behavior.
|
2022-08-12 20:46:36 +02:00
|
|
|
|
2024-03-17 13:44:39 +01:00
|
|
|
See all of them in [Keywords](../Keywords) and the sidebar.
|