diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..bd37a29 --- /dev/null +++ b/Installation.md @@ -0,0 +1,103 @@ +This wiki page will describe some of the different installation methods available for each OS: + +# Windows + +## Installer + +Download the `advanced-scene-switcher-*-windows-x64-Installer.exe` file of the version of the plugin you want to install. + +![InstallWindows1](https://github.com/user-attachments/assets/1a8f161d-1fc4-482d-a20b-afbbabd0939a) + +Next open the downloaded installer and click on "More info" and "Run anyway" and follow the installer's instructions. + +![InstallWindows2](https://github.com/user-attachments/assets/f86b4d76-f47f-44ce-ba23-2b61f05a4e18) + +Once the installation is complete open up OBS and the `Advanced Scene Switcher` entry should be available in the `Tools` menu: + +![image](https://github.com/user-attachments/assets/5b65cec6-66ef-4510-970e-b3b07d1225b5) + +## Manual install + +If you want to manually install the plugin download the `advanced-scene-switcher-*-windows-x64.zip` archive instead. +Extract the contents of this archive into your OBS installation directory, so that the contents of the `data` folder will be merged into OBS' `data` folder and the contents of the `obs-plugins` folder will be merged into OBS' `obs-plugins` folder. + +# MacOS + +## Installer + +It is recommend to download the `*.pkg` installer file of the desired version of the plugin: + +![InstallMacOS1](https://github.com/user-attachments/assets/3fe568dd-2a35-492a-9780-36871c03c2f2) + +Next you will have to "right-click" on the downloaded `*.pkg` file and select "Open". +Then click "Open" again and click through the installer's instructions. + +![InstallMacOS2](https://github.com/user-attachments/assets/4f451092-ce23-4d06-b3b7-349265919544) + +Once that is complete launch OBS and you should be able to see the Advanced Scene Switcher entry in the "Tools" menu: + +![1745399015955](https://github.com/user-attachments/assets/0530ec3f-deb7-496e-b31f-ae4e249d301f) + +On some MacOS versions and depending on its security settings you might also have to explicitly allow the plugin to be loaded: + +![1745398902663](https://github.com/user-attachments/assets/451933fc-5744-448a-a590-01dbd84117b9) + +## Manual install (*not* recommended) + +If you want to manually install the plugin you will have to download the `advanced-scene-switcher-*-macos-universal.tar.xz` archive of the plugin version you want to install. + +Now copy the contents of this archive to: +``` +~/Library/Application Support/obs-studio/plugins/advanced-scene-switcher.plugin +``` + +Afterwards open up the "Terminal" application and run this command: +``` +codesign --force --deep --sign - ~/Library/Application\ Support/obs-studio/plugins/advanced-scene-switcher.plugin +``` +This will ensure that the plugin files are properly "signed" after they were installed manually. +If this step is not performed OBS will fail to launch with an error similar to this one: + +``` +Exception Type: EXC_BAD_ACCESS (SIGKILL - Code Signature Invalid) +Termination Reason: Namespace CODESIGNING, Code 2 Invalid Page +``` + +# Linux + +## Prebuilt release binaries + +If you are using Ubuntu 24 you can download and install the prebuilt deb package available with each release. +So, for example: + +``` +advanced-scene-switcher-1.29.3-x86_64-linux-gnu.deb +``` + +Prior to version 1.29.0 the release binaries were built for Ubuntu 22 environments. + +## Flatpak + +A Flatpak package is available and can be installed via: +``` +flatpak install com.obsproject.Studio.Plugin.SceneSwitcher +``` + +Note that due to the Flatpak sandboxing some functionality might be limited. + +## Snap + +The plugin is included in the following snap package. + +``` +sudo snap install obs-studio +``` + +## Other + +Some distributions offer the option to install the plugin via their respective package manager. +For example: + +* Debian: `obs-advanced-scene-switcher` +* Arch Linux: `obs-advanced-scene-switcher` +* ... \ No newline at end of file