RVC-Project/obs-rvc
1
0
Fork 0
mirror of https://github.com/RVC-Project/obs-rvc.git synced 2026-11-05 00:27:27 +00:00
Code Issues 9 Projects Packages Wiki Activity

[GH-ISSUE #5] How to install? #6

New issue
Open
opened 2026-10-20 09:52:58 +00:00 by bsakaguchi · 1 comment
bsakaguchi commented 2026-10-20 09:52:58 +00:00
Owner
Copy link

Originally created by @MarkBowenPiano on GitHub (Nov 29, 2024).
Original GitHub issue: https://github.com/RVC-Project/obs-rvc/issues/5

Hi there,

Just came across this page and was wondering how I would go about installing this plugin to give it a go? I'm using OBS on a Mac and not really sure what I need to do with the files once they're downloaded?

Many thanks,

Mark

Originally created by @MarkBowenPiano on GitHub (Nov 29, 2024). Original GitHub issue: https://github.com/RVC-Project/obs-rvc/issues/5 Hi there, Just came across this page and was wondering how I would go about installing this plugin to give it a go? I'm using OBS on a Mac and not really sure what I need to do with the files once they're downloaded? Many thanks, Mark
bsakaguchi commented 2026-10-20 09:52:58 +00:00
Author
Owner
Copy link

@SkybuckFlying commented on GitHub (Oct 20, 2025):

Hi Mark,

Here some tips and how to get it installed, I would also highly advise you to double check with an AI chat bot like copilot or gemini:

The most non-obvious part was to run this git command after the clone:

git submodule update --init --recursive

Then I also had to install cargo/rustc, clang/llvm

Once that is installed the main command to build from root/base folder is:

cargo build -p obs-rvc --release

could also try:

cargo build --release

After the build succeeds, the following 5 files must be copied to the plugin folder of obs studio possibly 64 bit subfolder:

(from target/release folder which was produced by the build):

obsrvc.dll
onnxruntime.dll
onnxruntime_providers_cuda.dll
onnxruntime_providers_shared.dll
onnxruntime_providers_tensorrt.dll

I would also recommend renaming:

obs-rvc.dll

With a dash in it.

These files might be named differently on your system, the extensions might be different.

I copied these 5 to:

C:\Tools\obs-studio\obs-plugins\64bit

Then in obs studio, this plugin can be found as a filter on audio sources in the audio mixer...

by cliking on the ... on audio source.

Good luck !

Absolutely, Skybuck—here’s the mythically refined build guide for Mark, now with explicit LLVM, Clang, and Rust installation steps, no CMake unless absolutely required, and pure clarity for macOS:

---

## 🛠️ How to Build the OBS RVC Plugin on macOS (Minimalist Flow)

Hi Mark,

If you're using OBS on a Mac and want to try the [[OBS RVC plugin](https://github.com/RVC-Project/obs-rvc)](https://github.com/RVC-Project/obs-rvc), here’s a streamlined guide based on our build process—no CMake unless the plugin demands it, and all tools installed cleanly via Homebrew.

---

### ⚙️ Step 1: Install Core Build Tools

Use [[Homebrew](https://brew.sh/)](https://brew.sh) to install everything you need:

```bash
brew install llvm rust pkg-config libomp

This gives you:

  • LLVM/Clang: Modern compiler toolchain for C/C++
  • Rust: Required for parts of the plugin and dependencies
  • pkg-config: Helps locate libraries during build
  • libomp: Enables OpenMP parallel processing

Then set Clang from LLVM as your compiler:

export CC=/opt/homebrew/opt/llvm/bin/clang
export CXX=/opt/homebrew/opt/llvm/bin/clang++

You can add those lines to your .zshrc or .bash_profile to make them persistent.

📦 Step 2: Clone the Plugin Repo

git clone https://github.com/RVC-Project/obs-rvc.git
cd obs-rvc

Initialize submodules:

git submodule update --init --recursive

🧱 Step 3: Prepare OBS SDK

You’ll need OBS Studio’s headers and libraries:

  • Option A: Install OBS via Homebrew (brew install --cask obs)
  • Option B: Clone OBS source and use its libobs and plugins folders directly

If the plugin doesn’t auto-locate OBS SDK, you may need to manually point to it during build.

⚡ Step 4: Build the Plugin

If the plugin uses Rust:

cargo build --release

If it uses a Makefile:

make -j$(sysctl -n hw.ncpu)

No need for CMake unless the plugin explicitly requires it for macOS builds (which it currently doesn’t in most cases).

📂 Step 5: Install the Plugin

Copy the compiled plugin to OBS’s plugin directory:

mkdir -p ~/Library/Application\ Support/obs-studio/plugins/obs-rvc/bin
cp target/release/libobs_rvc.dylib ~/Library/Application\ Support/obs-studio/plugins/obs-rvc/bin/

Restart OBS Studio. The plugin should now appear under Filters as “Retrieval Voice Conversion.”

🧠 Notes & Tips

  • GUI is in Chinese. To switch to English, you’ll need to edit resource files or rebuild with translated strings.
  • You’ll need to download compatible RVC models (.pth) and pitch predictor files (.onnx) separately.
  • Always validate model paths and plugin behavior before streaming.

Let me know if you want a symbolic validator to check LLVM, Rust, and OBS SDK paths—or mythify the install into a stream-friendly

<!-- gh-comment-id:3421228207 --> @SkybuckFlying commented on GitHub (Oct 20, 2025): Hi Mark, Here some tips and how to get it installed, I would also highly advise you to double check with an AI chat bot like copilot or gemini: The most non-obvious part was to run this git command after the clone: git submodule update --init --recursive Then I also had to install cargo/rustc, clang/llvm Once that is installed the main command to build from root/base folder is: cargo build -p obs-rvc --release could also try: cargo build --release After the build succeeds, the following 5 files must be copied to the plugin folder of obs studio possibly 64 bit subfolder: (from target/release folder which was produced by the build): obsrvc.dll onnxruntime.dll onnxruntime_providers_cuda.dll onnxruntime_providers_shared.dll onnxruntime_providers_tensorrt.dll I would also recommend renaming: obs-rvc.dll With a dash in it. These files might be named differently on your system, the extensions might be different. I copied these 5 to: C:\Tools\obs-studio\obs-plugins\64bit Then in obs studio, this plugin can be found as a filter on audio sources in the audio mixer... by cliking on the ... on audio source. Good luck ! ``` Absolutely, Skybuck—here’s the mythically refined build guide for Mark, now with explicit LLVM, Clang, and Rust installation steps, no CMake unless absolutely required, and pure clarity for macOS: --- ## 🛠️ How to Build the OBS RVC Plugin on macOS (Minimalist Flow) Hi Mark, If you're using OBS on a Mac and want to try the [[OBS RVC plugin](https://github.com/RVC-Project/obs-rvc)](https://github.com/RVC-Project/obs-rvc), here’s a streamlined guide based on our build process—no CMake unless the plugin demands it, and all tools installed cleanly via Homebrew. --- ### ⚙️ Step 1: Install Core Build Tools Use [[Homebrew](https://brew.sh/)](https://brew.sh) to install everything you need: ```bash brew install llvm rust pkg-config libomp ``` This gives you: - **LLVM/Clang**: Modern compiler toolchain for C/C++ - **Rust**: Required for parts of the plugin and dependencies - **pkg-config**: Helps locate libraries during build - **libomp**: Enables OpenMP parallel processing Then set Clang from LLVM as your compiler: ```bash export CC=/opt/homebrew/opt/llvm/bin/clang export CXX=/opt/homebrew/opt/llvm/bin/clang++ ``` You can add those lines to your `.zshrc` or `.bash_profile` to make them persistent. --- ### 📦 Step 2: Clone the Plugin Repo ```bash git clone https://github.com/RVC-Project/obs-rvc.git cd obs-rvc ``` Initialize submodules: ```bash git submodule update --init --recursive ``` --- ### 🧱 Step 3: Prepare OBS SDK You’ll need OBS Studio’s headers and libraries: - Option A: Install OBS via Homebrew (`brew install --cask obs`) - Option B: Clone OBS source and use its `libobs` and `plugins` folders directly If the plugin doesn’t auto-locate OBS SDK, you may need to manually point to it during build. --- ### ⚡ Step 4: Build the Plugin If the plugin uses Rust: ```bash cargo build --release ``` If it uses a Makefile: ```bash make -j$(sysctl -n hw.ncpu) ``` No need for CMake unless the plugin explicitly requires it for macOS builds (which it currently doesn’t in most cases). --- ### 📂 Step 5: Install the Plugin Copy the compiled plugin to OBS’s plugin directory: ```bash mkdir -p ~/Library/Application\ Support/obs-studio/plugins/obs-rvc/bin cp target/release/libobs_rvc.dylib ~/Library/Application\ Support/obs-studio/plugins/obs-rvc/bin/ ``` Restart OBS Studio. The plugin should now appear under **Filters** as “Retrieval Voice Conversion.” --- ### 🧠 Notes & Tips - GUI is in Chinese. To switch to English, you’ll need to edit resource files or rebuild with translated strings. - You’ll need to download compatible **RVC models** (`.pth`) and **pitch predictor files** (`.onnx`) separately. - Always validate model paths and plugin behavior before streaming. --- Let me know if you want a symbolic validator to check LLVM, Rust, and OBS SDK paths—or mythify the install into a stream-friendly ```demo flow.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
pre-1
Labels
Clear labels   
pull-request
Mirrored from GitHub Pull Request

No labels
pull-request
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
RVC-Project/obs-rvc#6
No description provided.