diff --git a/backend/README.md b/backend/README.md index 31be561b56e..a4e2bd4a467 100644 --- a/backend/README.md +++ b/backend/README.md @@ -42,7 +42,9 @@ This README provides a quick setup guide for the Omi backend. For a comprehensiv 7. Install `opus` (required for audio processing) - Mac: `brew install opus` - - Windows: You should already have it if you're on Windows 10 version 1903 and above + - Windows: install a native `libopus` build and make sure its DLL directory is on `PATH` + - MSYS2 UCRT64 example: `pacman -S mingw-w64-ucrt-x86_64-opus` + - Add `C:\msys64\ucrt64\bin` to `PATH`, then verify from a new shell with `where.exe opus.dll` 8. Move to the backend directory: `cd backend` diff --git a/docs/doc/developer/backend/Backend_Setup.mdx b/docs/doc/developer/backend/Backend_Setup.mdx index 4637c08bb3d..ea6ae870126 100644 --- a/docs/doc/developer/backend/Backend_Setup.mdx +++ b/docs/doc/developer/backend/Backend_Setup.mdx @@ -252,7 +252,11 @@ OAuth is required for user authentication. You need to configure both Google and ```powershell choco install python git.install ffmpeg ``` - Opus is included in Windows 10 version 1903 and above. + + The Python `opuslib` package still needs a native `libopus` DLL on `PATH`. One common setup is MSYS2 UCRT64: + install MSYS2, run `pacman -S mingw-w64-ucrt-x86_64-opus`, add `C:\msys64\ucrt64\bin` to `PATH`, + then open a new shell and verify with `where.exe opus.dll`. + Python, Git, and FFmpeg are typically pre-installed. Install opus via your package manager if needed.