2023-02-27 13:38:23 +01:00
|
|
|
This page will tell you how to use plugins.
|
2023-02-27 13:32:56 +01:00
|
|
|
|
|
|
|
|
{{< toc >}}
|
|
|
|
|
|
|
|
|
|
## Getting plugins
|
|
|
|
|
|
|
|
|
|
Plugins come as _shared objects_, aka. `.so` files.
|
|
|
|
|
|
|
|
|
|
Hyprland does not have any "default" plugins, so any plugin you may want
|
|
|
|
|
to use you will have to find yourself.
|
|
|
|
|
|
|
|
|
|
## Installing / Using plugins
|
|
|
|
|
|
|
|
|
|
Clone and compile plugin(s) of your choice.
|
|
|
|
|
|
|
|
|
|
{{< hint type=tip >}}
|
|
|
|
|
Due to the fact that plugins share C++ objects, your plugins must be
|
|
|
|
|
compiled with the same compiler as Hyprland, and on the same architecture.
|
|
|
|
|
|
|
|
|
|
In rare cases, they might even need to be compiled on the same machine.
|
|
|
|
|
|
|
|
|
|
Official releases are always compiled with `gcc`.
|
|
|
|
|
{{< /hint >}}
|
|
|
|
|
|
|
|
|
|
Place them somewhere on your system.
|
|
|
|
|
|
|
|
|
|
In hyprland, run in a terminal:
|
|
|
|
|
```sh
|
|
|
|
|
hyprctl plugin load /path/to/the/plugin.so
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can also add this to an `exec-once`:
|
|
|
|
|
```ini
|
|
|
|
|
exec-once = hyprctl plugin load /my/epic/plugin.so
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
{{< hint type=warning >}}
|
|
|
|
|
Plugins are written in C++ and will run as a part of Hyprland.
|
|
|
|
|
|
|
|
|
|
Make sure to _always_ read the source code of the plugins you are going to use
|
|
|
|
|
and to trust the source.
|
|
|
|
|
|
|
|
|
|
Writing a plugin to wipe your computer is easy.
|
|
|
|
|
|
|
|
|
|
***Never*** trust random `.so` files you receive from other people.
|
|
|
|
|
{{< /hint >}}
|
|
|
|
|
|
|
|
|
|
## FAQ About Plugins
|
|
|
|
|
|
|
|
|
|
### My plugin crashes Hyprland!
|
|
|
|
|
Oops. Make sure your plugin is compiled on the same machine as Hyprland. If that doesn't help,
|
|
|
|
|
ask the plugin's maintainer to fix it.
|
|
|
|
|
|
|
|
|
|
### How do I list my loaded plugins?
|
|
|
|
|
`hyprctl plugin list`
|
|
|
|
|
|
|
|
|
|
### Can I unload a plugin?
|
|
|
|
|
Yes. `hyprctl plugin unload /path/to/plugin.so`
|
|
|
|
|
|
|
|
|
|
### How do I make my own plugin?
|
|
|
|
|
See [here](../Development/Getting-Started.md).
|
|
|
|
|
|
|
|
|
|
### Where do I find plugins?
|
|
|
|
|
Try looking around [here](https://duckduckgo.com).
|
|
|
|
|
|
|
|
|
|
### Are plugins safe?
|
|
|
|
|
As long as you read the source code of your plugin(s) and can see there's nothing bad going on,
|
|
|
|
|
they will be safe.
|
|
|
|
|
|
|
|
|
|
### Do plugins decrease Hyprland's stability?
|
|
|
|
|
Hyprland employs a few tactics to unload plugins that crash. However, those tactics may not
|
|
|
|
|
always work. In general, as long as the plugin is well-designed, it should not affect the
|
|
|
|
|
stability of Hyprland.
|
