Updates the plugin manager window to use the new failed module info.
Plugins installed in legacy folder locations are marked as Legacy with
a notice that will stop working in the future.
Plugins that failed to load are listed under an Errors section.
Plugins in the modules.json file that are not found are listed under
a Missing section. These entries can be removed from the modules.json
via a delete button.
This also cleans up some other small issues and updates the dialog
buttons to be Save/Discard instead of Ok/Close.
With this change module loading in the application is managed by the
plugin manager and allows the application to explicitly load core
modules independantly from 3rd party (plugin) modules.
The implementation is split into separate files for different platforms
to allow for cleaner code handling the different possible locations and
path schemes used, including all possible legacy locations and plugin
bundle formats.
This change introduces new locations and directory formats for plugins:
* WINDOWS: Portable plugins need to be placed in a directory called
"plugins" adjacent to the "bin" directory of an OBS Studio
installation.
* WINDOWS: Plugins need to be packaged into their own directory
"bundles", with the associated DLL in the root of the bundle and the
associated "data" directory next to it.
* WINDOWS: The "obs-plugins" directory adjacent to the "bin" directory
is deprecated and considered a legacy location for all plugins.
* MACOS: No changes in locations or formats.
* LINUX: Plugins distributed via system package managers now need to use
the "obs-modules/plugins" directory in the system library directory
for binaries, and the "obs/obs-modules/plugins" directory in the
system data directory for resources.
* LINUX: The "obs-plugins" directories in the system library and system
data directories are deprecated.
* LINUX: Plugins distributed outside of system packages need to use the
same directory format as plugins for Windows (see above).
* LINUX: A "portable" plugin location like on Windows is not supported.
* LINUX: Proper XDG directory locations are scanned for plugins, using
XDG_CONFIG_HOME for the legacy plugin format and XDG_DATA_HOME for the
new plugin structure.
* LINUX: Changes Flatpak plugin loading to use the new plugin structure
(while still supporting the legacy structure), and moves Flatpak
specific plugin loading to its own source files.
* ALL PLATFORMS: A single environment variable "OBS_PLUGINS_PATH" can
now be used to provide a highest-priority location from which to load
plugins. This directory needs to contain plugin bundles per the new
format. The one exception is Flatpak which does not support loading
plugins from an env provided location.
* ALL PLATFORMS: A custom legacy plugin locations can still be provided
via the "OBS_LEGACY_PLUGINS_PATH" and "OBS_LEGACY_PLUGINS_DATA_PATH"
environment variables. These are only compatible with plugins using
the legacy format and are considered deprecated. The one exception is
Flatpak which does not support loading plugins from an env provided
location.
Co-authored-by: PatTheMav <PatTheMav@users.noreply.github.com>
Current code isn't catching a parse error exception if an invalid config
file is loaded by the plugin manager. This change wraps the plugin
manager config json parse call with a try/catch, and handles invalid
config files by creating a new config file, and logs an error that the
existing config file is invalid.
For phase 1 of the plugin manager, the ability to toggle off/on plugins
to be loaded at launch is provided.
This commit adds a new Plugin Manager dialog which can be accessed from
the Tools menu, which shows a list of all installed 3rd party plugins
with a checkbox to toggle them off or on. If a change is made, the user
is prompted to restart OBS. To allow this, the plugin manager uses a
json based config file stored in the OBS config directory. Additionally
for sources in the source tree, a sample UI has been provided that
indicates any sources whose parent module is disabled, by turning its
title red.
Warchamp7