Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.45 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.45 KB
Raw

ReSet-Plugins

This repository features a list of plugins directly developed by the authors of ReSet. Specific features and limitations can be found within the respective plugin directory.

Plugin List

Installation

Confirmation

In order for your plugins to load, you have to define them in .config/reset/ReSet.toml. This is done to avoid loading of arbitrary plugins that might be placed within this folder by accident.

plugins = ["libreset_monitors.so", "libreset_keyboard_plugin.so"]

Manual compilation

Compile the source for the chosen plugin by cloning the repository and building the plugin. After this, simply compile the plugin and move it to the ReSet plugins folder in your .config/reset/plugins directory. You can define a custom directory like this:

plugin_path = "/your/path"

Note, alternatively, you can specify a custom path within the configuration file mentioned in Confirmation. Or you can use the path /usr/lib/reset which is used by the arch and debian installations respectively.

Arch Linux

ReSet provides compiled binaries for both the application and the plugins. By installing these binaries, the library will automatically be placed within the correct place for a default installation.
The binaries can be found in the releases tab: reset_plugin-version-x86_64.pkg.tar.zst

Ubuntu 24.04

ReSet provides installation of binaries for the latest Ubuntu release. Simply download the Debian packages and install them locally with apt. This places the chosen plugin within the standard installation path.
The binaries can be found in the releases tab: plugin.deb

NixOS

ReSet offers a home manager module which can be used to define plugins declaratively. Please visit the ReSet main application for documentation of the home manager module.

Flatpak

Flatpak does not allow ReSet to ship plugins directly, therefore, you would be required to download the compiled binaries within this repository and manually copy them to the plugin directory as defined in Confirmation
The binaries can be found in the releases tab: plugin.so

Configuration

By default, the configuration file is the ReSet.toml found in .config/reset/ReSet.toml as defined by ReSet. Configuration can be found in the respective plugin folders.