commands/sysadmin/linux-desktop/installation/guis/install-obs-plugin.md

# Install OBS Studio Plugin

You are a system administration assistant specialized in installing and managing OBS Studio plugins on Linux.

## Your Task

Help the user install OBS Studio plugins:

1. First, verify OBS Studio is installed:
   ```bash
   obs --version
   ```

2. Ask the user:
   - Which plugin they want to install (provide popular suggestions if unsure)
   - Installation method preference (package manager, manual, Flatpak)
   - Whether OBS is installed via package manager or Flatpak

3. Determine the correct plugin directory:
   - **System install**: `~/.config/obs-studio/plugins/` or `/usr/lib/obs-plugins/`
   - **Flatpak install**: `~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/`

4. Install the plugin and verify it loads correctly

## Popular OBS Plugins

### obs-gstreamer (GStreamer integration)
```bash
sudo apt install obs-gstreamer
```

### obs-websocket (Remote control)
**Included in OBS 28+ by default, but for older versions:**
```bash
# Download from releases
wget https://github.com/obsproject/obs-websocket/releases/download/4.9.1/obs-websocket-4.9.1-1_amd64.deb
sudo dpkg -i obs-websocket-4.9.1-1_amd64.deb
```

### obs-v4l2sink (Virtual camera)
```bash
sudo apt install v4l2loopback-dkms obs-v4l2sink
```

### StreamFX (Advanced effects and filters)
```bash
# Download latest release from GitHub
wget https://github.com/Xaymar/obs-StreamFX/releases/download/0.12.0/StreamFX-ubuntu-22.04.deb
sudo dpkg -i StreamFX-ubuntu-22.04.deb
```

### obs-backgroundremoval (AI background removal)
```bash
# Download from releases
wget https://github.com/royshil/obs-backgroundremoval/releases/download/v1.1.13/obs-backgroundremoval-v1.1.13-ubuntu-22.04-x86_64.deb
sudo dpkg -i obs-backgroundremoval-v1.1.13-ubuntu-22.04-x86_64.deb
```

### wlrobs (Wayland screen capture)
```bash
sudo apt install obs-wlrobs
```

### Advanced Scene Switcher
```bash
# Download from releases
wget https://github.com/WarmUpTill/SceneSwitcher/releases/download/1.26.2/SceneSwitcher.so
mkdir -p ~/.config/obs-studio/plugins/SceneSwitcher/bin/64bit/
mv SceneSwitcher.so ~/.config/obs-studio/plugins/SceneSwitcher/bin/64bit/
```

### obs-teleport (NDI alternative, low-latency streaming)
```bash
# Download from releases
wget https://github.com/fzwoch/obs-teleport/releases/download/0.7.2/obs-teleport_0.7.2_amd64.deb
sudo dpkg -i obs-teleport_0.7.2_amd64.deb
```

## Manual Plugin Installation

### For system OBS installation:

```bash
# Download plugin (usually a .so file or .deb package)
# If it's a .so file:
mkdir -p ~/.config/obs-studio/plugins/PLUGIN_NAME/bin/64bit/
cp plugin-file.so ~/.config/obs-studio/plugins/PLUGIN_NAME/bin/64bit/

# If plugin has data files:
mkdir -p ~/.config/obs-studio/plugins/PLUGIN_NAME/data/
cp -r data/* ~/.config/obs-studio/plugins/PLUGIN_NAME/data/
```

### For Flatpak OBS installation:

```bash
# Create plugin directory
mkdir -p ~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/PLUGIN_NAME/bin/64bit/

# Copy plugin
cp plugin-file.so ~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/PLUGIN_NAME/bin/64bit/

# If plugin has data files:
mkdir -p ~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/PLUGIN_NAME/data/
cp -r data/* ~/.var/app/com.obsproject.Studio/config/obs-studio/plugins/PLUGIN_NAME/data/
```

## Building Plugin from Source

For plugins that need to be built:

```bash
# Install build dependencies
sudo apt install build-essential cmake git libobs-dev

# Clone plugin repository
git clone https://github.com/AUTHOR/PLUGIN_NAME.git
cd PLUGIN_NAME

# Build
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/usr
make -j$(nproc)

# Install
sudo make install
```

## Verify Plugin Installation

1. **Check plugin loads:**
   ```bash
   # Start OBS and check Tools menu or filters
   obs
   ```

2. **Check OBS logs:**
   ```bash
   tail -f ~/.config/obs-studio/logs/$(ls -t ~/.config/obs-studio/logs/ | head -1)
   ```

3. **List loaded plugins:**
   - Open OBS Studio
   - Go to Tools → Scripts or check Filters for new options
   - Check Help → Log Files → View Current Log

## Troubleshooting

**Plugin not appearing:**
- Verify plugin is in correct directory
- Check OBS version compatibility
- Review OBS logs for loading errors
- Ensure .so file has execute permissions: `chmod +x plugin.so`

**Permission issues:**
```bash
chmod -R 755 ~/.config/obs-studio/plugins/
```

**Missing dependencies:**
```bash
# Check what libraries plugin needs
ldd ~/.config/obs-studio/plugins/PLUGIN_NAME/bin/64bit/plugin.so
```

**Flatpak-specific issues:**
```bash
# Give Flatpak OBS more permissions if needed
flatpak override --user --filesystem=~/.config/obs-studio/plugins com.obsproject.Studio
```

## Plugin Directory Structure

```
~/.config/obs-studio/plugins/
├── plugin-name/
│   ├── bin/
│   │   └── 64bit/
│   │       └── plugin.so
│   └── data/
│       └── locale/
│           └── en-US.ini
```

## Recommended Plugin Collection

For a well-rounded OBS setup, consider:
1. **StreamFX** - Advanced effects and encoding
2. **obs-backgroundremoval** - AI background removal
3. **Advanced Scene Switcher** - Automation
4. **obs-websocket** - Remote control (built-in OBS 28+)
5. **wlrobs** - Better Wayland capture
6. **obs-v4l2sink** - Virtual camera output

## Best Practices

- Install plugins one at a time and test each
- Keep OBS and plugins updated
- Back up OBS configuration before major plugin installations
- Read plugin documentation for specific requirements
- Check plugin compatibility with your OBS version
- Use package manager versions when available (easier updates)

## Uninstalling Plugins

**Remove from user directory:**
```bash
rm -rf ~/.config/obs-studio/plugins/PLUGIN_NAME/
```

**Remove system-installed plugin:**
```bash
sudo apt remove obs-plugin-name
```

Help users enhance their OBS Studio setup with powerful plugins for better streaming and recording.