Obs studio templates update#
Obs studio templates windows#

Only presets appropriate for the current build host are available for selection.Īdditional build system options are available to developers:

Obs studio templates windows#

Presets can be either specified on the command line ( cmake -preset ) or via the associated select field in the CMake Windows GUI.

Provided as an experimental preview feature.

Defaults to RelWithDebInfo build configuration.

Defaults to macOS deployment target 11.0.

Universal architecture (supports Intel-based CPUs as Apple Silicon).

The plugin template supports CMake presets using the CMakePresets.json file and ships with default presets: To create a build configuration, cmake needs to be installed on the system. As an example, building on Ubuntu requires the following packages to be installed: Linux dependencies need to be resolved using the package management tools appropriate for the local distribution.

Obs studio templates update#

To update a dependency, change the version and associated hashes entries to match the new version. The values should be kept in sync with OBS Studio releases and the buildspec.json file in use by the main project to ensure that the plugin is developed and built in sync with its target environment.

tools: Contains additional build tools used by CI.qt6: Prebuilt version of Qt6 as used by OBS Studio.prebuilt: Prebuilt OBS Studio dependencies.obs-studio: Version of OBS Studio to build plugin with (needed for libobs and obs-frontend-api).Windows and macOS dependency downloads are configured in the buildspec.json file: On Linux, the version used for development might be decided by the specific version available via a distribution's package management system, so OBS Studio compatibility for plugins might be determined by those versions instead. Users are encouraged to always update to the most recent version of OBS Studio available within a reasonable time after release - plugin authors have to choose for themselves if they'd rather keep up with OBS Studio releases or stay with an older version as their baseline (which might of course preclude the plugin from using functionality introduced in a newer version).Plugins targeting the latest version of OBS Studio might not work in older versions because the internal data structures used by libobs might not be compatible.Plugins targeting older versions of OBS Studio should generally also work in newer versions, with the exception of breaking changes to specific APIs which would also be explicitly called out in release notes.As far as updating the targeted OBS Studio version is concerned, a few things need to be considered:

Choose An OBS Studio Versionīy default the plugin template specifies the most current official OBS Studio version in the buildspec.json file, which makes most sense for plugins at the start of development. Just like OBS Studio itself, plugins need to be built using dependencies available either via the obs-deps repository (Windows and macOS) or via a distribution's package system (Linux).

Should be unique and follow reverse domain name notation. bundleId: macOS bundle identifier for the plugin.

Platform-specific settings are set up in the platformConfig section of the buildspec file: These values are read and processed automatically by the CMake build scripts, so no further adjustments in other files are needed.

windowsApp: Unique ( !) identifier for the Windows plugin installer.

macosInstaller: Unique ( !) identifier for the macOS plugin installer.

macosPackage: Unique ( !) identifier for the macOS plugin package.

email: Contact email address associated with the plugin.

website: URL of a website associated with the plugin.

author: Actual name or nickname of the plugin's author.

The following fields should be customized for an actual plugin: The plugin project is set up using the included buildspec.json file.

GitHub Actions workflows and repository actions.

The plugin template is meant to be used as a starting point for OBS Studio plugin development.