Skip to content

[codex] Document Windows libopus setup #7929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tianmind-studio wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[codex] Document Windows libopus setup #7929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80d93e9
Document Windows libopus setup
tianmind-studio Jun 14, 2026
8766d30
Update backend setup Opus note
tianmind-studio Jun 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
6 changes: 5 additions & 1 deletion docs/doc/developer/backend/Backend_Setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,11 @@ OAuth is required for user authentication. You need to configure both Google and
```powershell
choco install python git.install ffmpeg
```
<Note>Opus is included in Windows 10 version 1903 and above.</Note>
<Note>
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`.
</Note>
</Tab>
<Tab title="Linux/Nix">
Python, Git, and FFmpeg are typically pre-installed. Install opus via your package manager if needed.
Expand Down
Loading