diff --git a/Installation.md b/Installation.md index 1a44bc9..ec8d0ce 100644 --- a/Installation.md +++ b/Installation.md @@ -4,18 +4,35 @@ There are several ways to install the plugin, each one more difficult than the p To ensure that you will not run into problems, make sure to disable or remove the following software before attempting an install. ## Windows: +* OBS Studio running in 32-bit: No longer supported since about mid to late 2019. * Norton Antivirus: Known to cause problems with .exe and .zip installs by randomly removing or replacing files. * Avira: Known to cause problems with .exe installs by randomly deleting files that were just installed. * Avast: See Avira. +# Software Requirements: +For the plugin to work correctly, the following software or packages must be installed on the system: + +## Windows: +* Windows 10 64-bit or Windows 7 64-bit (with all updates). +* [Open Broadcaster Software Studio](https://obsproject.com/) Version 24.0.3 or newer. +* [Microsoft Visual C++ 2019 Redistributables](https://aka.ms/vs/16/release/vc_redist.x64.exe) for x86_64/x64/64-bit. + +## Linux: +* Any 64-bit Linux compatible OS. +* [Open Broadcaster Software Studio](https://obsproject.com/) Version 24.0.3 or newer. +* libstdc++ that is compatible with C++17 for your distribution of Linux. + +## Mac: +* Keep dreaming or build it yourself. + # Using the Installer (Windows only) -OBS FFmpeg Encoder(s) ships with an .exe installer that will automatically search for an installed OBS Studio (not a portable OBS Studio) and will install the plugin correctly there. Launch OBS Studio and you should now find the new encoders available in Output Mode Advanced. +FFmpeg Encoders (for OBS Studio) ships with an .exe installer that will automatically search for an installed OBS Studio (not a portable OBS Studio) and will install the plugin correctly there. Launch OBS Studio and all the new sources, transitions and filters are now available to you. # Using the Zip and 7Z Archives (Windows only) These archives have their content structure exactly identical to the one required by a Windows OBS Studio installation. Extract them to the place you installed OBS Studio to (usually C:\Program Files (x86)\obs-studio) and then launch OBS Studio. You should now find the new encoders available in Output Mode Advanced. # Building together with OBS Studio (All platforms) -1. Follow the OBS Studio compiling guide for Windows. +1. Follow the [OBS Studio compiling guide for the platform](https://obsproject.com/wiki/install-instructions). 2. Clone obs-ffmpeg-encoder to `/plugins/obs-ffmpeg-encoder` (should have a CMakeLists.txt at `/plugin/obs-ffmpeg-encoder/CMakeLists.txt`). 3. Add `add_subdirectory(obs-ffmpeg-encoder)` to `/plugins/CMakeLists.txt`. 4. Build OBS Studio.