This plugin adds the ability to create presets from your RuneLite plugin configurations.
Download the Plugin Presets plugin from the RuneLite Plugin Hub and enable it.
Click the green + sign to create a new empty plugin preset. Plugin Presets are text files that are stored in your presets folder at ~/.runelite/presets/ or alternatively in your RuneLite configurations in ~/.runelite/settings.properties file and they store any configurations that you can edit from the RuneLite configuration sidepanel.
The orange switch indicates whether the preset's saved configurations match your current configurations. Loading a preset will copy all of those setting in the preset file to your current RuneLite configurations as if you manually changed all of your plugin configurations to match the presets ones. If the switch is off, it means that some of your configurations don't match the presets configurations.
The cog icon in the preset panel opens the preset editor. In the editor view you can view, add, update and remove plugin configurations from your plugin presets. The checkboxes visualize whether or not the preset has stored any configurations to a certain plugin. If the checkbox is checked, that preset has stored some configurations and loading it will enable those configurations for you.
When the presets and your configurations differ, the edit panel will display a modified icon next to the checkbox. This means that the preset has stored different configuration to the plugin that you currently have enabled. One case would be that the preset has stored a nice yellow sunset color for the Skybox plugin, but after creating that preset, you have changed your skybox color to a blue daylight. In that case, left of the checkbox, a modified icon would be visible. Clicking the modified icon will Update the presets configuration with your current configuration, which means that after clicking it, the preset would now store your blue daylight color instead of the yellow sunset.
The modification icon does not mean that you need to always update that configuration since the reason to use this plugin is to have the ability to change between different configurations easily. For example, you could have 2 presets that store different color configurations to the skybox plugin and when enabling one of the presets, naturally the other preset will display a modified icon since, from the other preset's perspective, the configurations have changed since creation.
Presets can be bound to custom keybinds by clicking the Not set text. After clicking, type a key combination and it should be show on the panel. Once you are happy with the keybind, click save or press enter. Now the preset gets loaded after you press the keybind in game. Note that other plugins also have keybinds and those may or may not override your preset keybind, so prefer not to use duplicate keybindings.
A single keybind only enables one preset, so if you want to enable multiple presets with one keybind, consider creating a single preset containing the configurations from the presets you wish to enable.
Presets can be loaded based on RuneLite client focus or unfocus. You can set the desired focus activation by right-clicking the load preset icon. Client unfocus can happen when alt tabbing to another window, opening some other RuneLite sidebar panel, opening some context menu or popup. You can temporarily pause the focus activation by clicking the play/pause button in the top right corner. One should pause the focus activation if making changes to preset configurations (editing configurations, keybinds or renaming presets) or editing other RuneLite plugin configurations.
Focus activation can be e.g. used to turn some plugins off to lower RuneLites computing power, limit draw distance or maybe make the client smaller when not using it. It's recommended to use focus activation with care since loading big presets will cause lag from loading many configurations and mostly cause more problems than help.
Your plugin presets can become fairly messy after a while or cause problems if changing a lot of configurations between preset creations. To avoid confusion and problems, name your presets well and keep your presets up to date. Prefer to have presets only contain the configurations you wish to change, this also increases performance and reduces the strain to keep your presets up to date. You might want to consider only toggling complex plugins on or off in your preset rather than have it modify all the plugin's settings.
Your presets are stored in the ~/.runelite/presets/ folder or alternatively in the settings.properties configuration file. In the preset editor view you can toggle where the plugin is stored by clicking the file/cloud icon.
You can share these .json files with others, they don't contain information about your account, Discord or Twitch. Alternatively you can click the copy icon in the preset panel to copy the preset's data to your clipboard for easier sharing e.g. through Discord, Pastebin etc...
To "install" new presets, paste the .json file to the preset folder and then press the "refresh presets" button. Alternatively you can right-click the green + sign to import presets from clipboard. You can easily access your preset folder by right-clicking the Plugin Preset icon in the RuneLite sidebar.
Note that external presets might contain configurations different to yours, so when enabling presets from others, they might have changed e.g. keybinds that you might have set up differently. In the edit panel, you can view the plugins that the preset has some configurations. Alternatively you can view the raw json by copying it and pasting it to a json viewer. When sending presets to others, make sure to always double-check for sensitive information!
Some plugins have settings that are not configurable from the configurations tab, such as screen markers, object indicators, or ground markers. You can add those settings that are not included in presets by right-clicking the config name and choosing Add custom setting.
Custom settings require the config's configName and the custom settings settingKey. You can find those from your settings.properties file in ~/.runelite/ folder. There is no guarantee that custom settings will work correctly, since most of these settings are not meant to be changed on the fly. Use this feature at your own risk.
Custom settings in your configs are marked with a (C). If you uncheck a custom setting, it will be removed from your preset.
Adding screen markers to presets
Screen markers are not added to presets automatically since you can't edit markers from the configurations tab. To add markers to your presets, add custom setting "screenmarkers.markers" to your screen markers configurations and then "Markers" setting should be added to the preset.
If you've experienced an issue with Plugin Presets, or have a recommendation on how to improve it, please create an issue with relevant details.
See LICENSE.
See CHANGELOG.md.