Site Tools


resource:install_obs_plugin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
resource:install_obs_plugin [2025/08/01 12:34] adminresource:install_obs_plugin [2025/10/10 21:01] (current) – [Install Steps] admin
Line 5: Line 5:
 When you download an OBS plugin you will either get an installer which will auto install the plugin or you will download a bunch of files to place into the correct directory/directories. This page tries to set out the steps required for manual installation. When you download an OBS plugin you will either get an installer which will auto install the plugin or you will download a bunch of files to place into the correct directory/directories. This page tries to set out the steps required for manual installation.
  
-===== Windows =====+===== Windows Install – Older Plugin Versions Note ===== 
 + 
 +From ''version 2.0.12'' onwards, the plugin no longer provides a Windows installer. This is because the OBS plugin template code (used by this plugin) was removed by the OBS team. 
 + 
 +If you are installing a newer version of the plugin into the ''ProgramData'' folder and have an older version already installed, you will need to manually remove those older files once. After this clean up, future plugin updates will simply overwrite the existing plugin folder in ''C:\ProgramData\obs-studio\plugins''
 + 
 +Older versions of the plugin installed files directly into ''C:\Program Files\obs-studio''. You will need to delete these files, as they may interfere with the new installation. 
 + 
 +Delete the following files/folders if they exist: 
 + 
 +  * ''obs-plugin-countdown'' folder inside ''C:\Program Files\obs-studio\data\obs-plugins'' 
 +  * ''obs-plugin-countdown.dll'' and ''obs-plugin-countdown.pdb'' files inside ''C:\Program Files\obs-studio\obs-plugins\64bit'' 
 + 
 + 
 +===== Windows - Standard Install =====
  
 ==== Plugin Files ==== ==== Plugin Files ====
-Generally, you should have the following types of files for the plugin:+You should have a zip file that extracts into a folder that contains the plugin folder inside. This should be named ''obs-plugin-countdown''. It will contain two sub folders:
  
-  * A ''.dll'' file (the main plugin) +  * A ''bin'' folder that will have the ''.dll'' and ''.pdb''files inside (the main plugin files
-  * A ''.pdb'' file (optional) +  * A ''data'' folder containing the supporting files (e.g., ''.ini'', ''.json'', ''.data'', or folders with assets)
-  * Supporting files (e.g., ''.ini'', ''.json'', ''.data'', or folders with assets)+
  
 Plugins are usually built for either 64-bit or 32-bit OBS. From v28+ OBS is only available in 64-bit on Windows. Plugins are usually built for either 64-bit or 32-bit OBS. From v28+ OBS is only available in 64-bit on Windows.
  
 ==== Install Steps ==== ==== Install Steps ====
-There are multiple folders where you can place the plugin files. I believe it's best to choose the following folder location to prevent the need to reinstall plugins when updating OBS:+OBS plugin files should be located in the following folder:
 <file> <file>
-%APPDATA%/+C:\ProgramData\obs-studio\plugins
 </file> </file>
  
-=== Step 1 === +>Note: The ''ProgramData'' folder is a hidden folder on Windows. To see hidden files and folders: 
-Copy the ''.dll'' file to:+>  - Open ''File Explorer'' from the taskbar.  
 +>  - Select ''View > Show''
 +>  - Select ''Hidden items'' to view hidden files and folders. 
 + 
 +=== Step 1 - Main Plugin Files === 
 +Copy the plugin folder, in this case named ''obs-plugin-countdown'' to the following folder location:
 <file> <file>
-%APPDATA%+C:\ProgramData\obs-studio\plugins
 </file> </file>
  
-=== Step 2 === +=== Step 2 - Restart === 
-Copy the ''.pdb'' file to:+Restart OBS to detect the new plugin. 
 + 
 +===== Windows - Install Into OBS Folder ===== 
 +If you want to install the plugin for portable stand alone installs of OBS you can copy the files/folders into the OBS folder itself following these instructions. 
 + 
 +==== Plugin Files ==== 
 +You should have a zip file that extracts into a folder that contains the plugin folder inside. This should be named ''obs-plugin-countdown''. It will contain two sub folders: 
 + 
 +  * A ''bin'' folder that will have the ''.dll'' and ''.pdb''files inside (the main plugin files) 
 +  * A ''data'' folder containing the supporting files (e.g., ''.ini'', ''.json'', ''.data'', or folders with assets) 
 + 
 +Plugins are usually built for either 64-bit or 32-bit OBS. From v28+ OBS is only available in 64-bit on Windows. 
 + 
 +==== Install Steps ==== 
 +Locate the folder where you have the portable version of OBS installed.   
 +The instructions below use the placeholder ''OBS_Portable'' for the location of OBS.   
 +For example, if OBS is extracted to:
 <file> <file>
-%APPDATA%+D:\obs
 </file> </file>
  
-=== Step ===+=== Step 1 - Main Plugin Files === 
 +Copy the ''.dll'' and ''.pdb'' files from the plugin ZIP   
 +(located under ''obs-plugins\64bit'' or ''obs-plugins\32bit'') to: 
 +<file> 
 +{{OBS_Portable}}\obs-plugins\64bit\ 
 +</file> 
 +(or ''32bit'' if it’s a 32-bit plugin)
  
 +**Example:**
 +<file>
 +D:\obs\obs-plugins\64bit\
 +</file>
  
-=== Step ===+=== Step 2 - Data Folder === 
 +If the plugin includes a ''data'' folder, locate it inside the plugin ZIP: 
 +<file> 
 +{{main-plugin-folder}}\data 
 +</file> 
 + 
 +Go to the following folder location: 
 +<file> 
 +{{OBS_Portable}}\data\obs-plugins 
 +</file> 
 + 
 +Inside this location create a new folder called the plugin name (same as the unzipped plugin folder name i.e. ''obs-plugin-countdown''
 + 
 +**Example:** 
 +<file> 
 +D:\obs-studio\data\obs-plugins\<plugin-name>
 +</file> 
 + 
 +Copy the files and folders inside the unzipped ''data'' folder into this new location. There should at least be a folder called ''locale'' inside the ''data'' folder. 
 + 
 +=== Step 3 - Restart ===
 Restart OBS to detect the new plugin. Restart OBS to detect the new plugin.
  
Line 50: Line 114:
 ==== Install Steps ==== ==== Install Steps ====
  
-=== Step 1 ===+=== Step 1 - Plugin Folder ===
 Copy the ''.plugin'' file into the following folder on your Mac: Copy the ''.plugin'' file into the following folder on your Mac:
 <file> <file>
Line 56: Line 120:
 </file> </file>
  
-**Note: The ''Library'' folder is a hidden folder on MacOS. Use +**Note: The ''Library'' folder is a hidden folder on MacOS. Use the following command to toggle the view of hidden files and folders. **
 <code>CMD + SHFT + .</code> <code>CMD + SHFT + .</code>
-to toggle the view of hidden files and folders. ** 
  
-=== Step 2 ===+ 
 +=== Step 2 - Restart OBS ===
 Restart OBS to detect the new plugin. Restart OBS to detect the new plugin.
resource/install_obs_plugin.1754048071.txt.gz · Last modified: by admin