🇬🇧 English | 🇹🇷 Türkçe

Flood Tuber - OBS Plugin

Flood Tuber is a lightweight OBS Studio plugin that brings your streams to life with reactive PNGTuber avatars. It detects your microphone's audio levels to animate your avatar with talking, blinking, and random action states, adding dynamism to your content without complex setups.

Features

• 🎙️ Audio Reactive: Automatically switches between Idle and Talking states based on your microphone input.
• 🖼️ 3-Frame Talking Animation: Supports Talk A, Talk B, and Talk C frames for smoother and more natural talking animations.
• 📚 Avatar Library: Built-in library system to easily load and switch between different avatar presets (images + settings) with a single click.
• 👀 Auto-Blink: Adds life to your avatar with configurable automatic blinking intervals.
• ✨ Random Actions: Plays random action animations (like an emote or special pose) at set intervals.
• 🌊 Motion Effects:
  • Shake: Avatar vibrates/shakes when talking.
  • Bounce: Avatar bounces up and down when talking.
  • None: Static talking image.
• 🎞️ Advanced Animations: Full support for APNG, WebP, and GIF formats.
  • Smart Detection: Automatically detects animations even if file extensions are incorrect (e.g. APNG saved as .png).
• ⚡ Talking Animation Speed: Control how fast your avatar's mouth moves (frames/sec) with a dedicated slider.
• ↔️ Mirror Mode: Flip your avatar horizontally with a single checkbox.
• 🛠️ Custom Settings per Avatar: Each avatar in the library can have its own settings.ini to define specific sensitivities, speeds, and timings.

Installation

You can download the latest version of Flood Tuber from:

• Official OBS Resources Page
• GitHub Releases (Recommended)

Windows

Option 1: Installer (Recommended)

1. Download the FloodTuber-Installer.exe.
2. Run the installer.

   ⚠️ Note regarding "Windows protected your PC": Since this is an open-source project, I do not have an expensive code signing certificate. When you run the installer, Windows SmartScreen may show a warning saying "Unknown Publisher". This is completely normal for open-source software. To proceed:

   • Click "More Info"
   • Click "Run Anyway"

3. Follow the setup wizard instructions.

Option 2: Portable (Manual)

1. Download the FloodTuber-Portable.zip.
2. Extract the contents.
3. Copy the flood-tuber.dll into your OBS plugins folder (usually C:\Program Files\obs-studio\obs-plugins\64bit).
4. Copy the flood-tuber folder from the data/obs-plugins folder to the OBS data directory (usually C:\Program Files\obs-studio\data\obs-plugins\flood-tuber).
5. Restart OBS Studio.

macOS

Building from source

Prerequisites: OBS Studio (Homebrew), CMake, Git, and Xcode Command Line Tools.

# Install dependencies
brew install cmake obs-studio

Build and install:

git clone https://github.com/justflood/flood-tuber.git
cd flood-tuber
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
sudo cmake --install build --prefix /usr/local

Manual installation (portable)

1. Build as shown above.
2. Copy build/flood-tuber.so to ~/Library/Application Support/obs-studio/plugins/flood-tuber/bin/
3. Copy the data/ directory contents to ~/Library/Application Support/obs-studio/plugins/flood-tuber/data/
4. Restart OBS Studio.

Linux

Building from source

Prerequisites: OBS Studio development headers, CMake, Git, and a C++ compiler.

# Ubuntu/Debian
sudo apt install build-essential cmake git libobs-dev

# Fedora
sudo dnf install cmake git obs-studio-devel

Build and install:

git clone https://github.com/justflood/flood-tuber.git
cd flood-tuber
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build
sudo cmake --install build --prefix /usr

Manual installation (portable)

1. Build as shown above.
2. Copy build/flood-tuber.so to ~/.config/obs-studio/plugins/flood-tuber/bin/64bit/
3. Copy the data/ directory contents to ~/.config/obs-studio/plugins/flood-tuber/data/
4. Restart OBS Studio.

Usage

1. Add a new "Flood Tuber Avatar" source to your scene.
2. Select Audio Source: Choose your microphone from the properties list.
3. Load an Avatar:
   • Under "Avatar Library", select a preset (e.g., "Flood Tuber Avatar") and click "Load & Apply Avatar".
   • Or manually select your own images for Idle, Talk, Blink, etc.
4. Customize:
   • Adjust Threshold to match your voice level.
   • Enable Mirror to flip the avatar if needed.
   • Choose a Motion Type (Shake/Bounce) and adjust stickiness.

Creating Your Own Avatar

⚠️ IMPORTANT: STRICT FILE NAMING The plugin does NOT save custom file names to the settings. It strictly looks for exact filenames in the folder. You MUST name your image files exactly as shown below, otherwise the "Load & Apply" button will not work, and the plugin will "forget" your files when switching avatars.

1. Click "Open Avatars Folder" in the properties.
2. Create a new folder with your avatar's name (e.g., My Cool Avatar).
3. Place your images inside and rename them exactly like this:
   • idle.png
   • talk_a.png, talk_b.png, talk_c.png
   • blink.png
   • action.png
   • (Optional) talk_a_blink.png etc. for blinking while talking.
4. (Optional) Copy a settings.ini from another avatar to fine-tune default settings for this character.
5. In OBS, select your new folder from the list and click Load!

💬 Community & Support

Need help setting up your avatars, want to share your custom creations, or have a brilliant idea for a new feature?

Join the official Flood Tuber Discord server! It's the best place to get direct support, report bugs, and hang out with other users.

License

This project is licensed under the GNU General Public License v2.0 (GPLv2).