Skip to content

README Linux addendum, MoQ Source setup #17

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

Merged
kixelated merged 1 commit into from
Dec 28, 2025
Merged

README Linux addendum, MoQ Source setup #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 41 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ Prerequisites:
# macOS
cp -a build_macos/RelWithDebInfo/obs-moq.plugin ../obs-studio/build_macos/frontend/RelWithDebInfo/OBS.app/Contents/PlugIns/

# Linux
cp build_x86_64/obs-moq.so ~/.config/obs-studio/plugins/obs-moq/bin/64bit/obs-moq.so

# eventually, without the fork:
cp -a build_macos/RelWithDebInfo/obs-moq.plugin ~/Library/Application\ Support/obs-studio/plugins/
```
Expand All @@ -69,13 +72,13 @@ cp -a build_macos/RelWithDebInfo/obs-moq.plugin ~/Library/Application\ Support/o
RUST_LOG=debug RUST_BACKTRACE=1 OBS_LOG_LEVEL=debug ../obs-studio/build_macos/frontend/RelWithDebInfo/OBS.app/Contents/MacOS/OBS
```

## Usage
## Configuring MoQ Output Streaming

1. Open OBS Studio.
2. Go to **Settings** > **Stream**.
3. In the **Service** dropdown, select **MoQ**.
4. Enter your MoQ Server details:
* For development (`just dev`): `http://localhost:4433/anon`.
* For development (`just dev`): `http://localhost:4443/anon`.
* For testing: `https://cdn.moq.dev/anon`.
5. Enter the broadcast name/path:
* For testing: `obs` or some unique string.
Expand All @@ -84,6 +87,40 @@ RUST_LOG=debug RUST_BACKTRACE=1 OBS_LOG_LEVEL=debug ../obs-studio/build_macos/fr
* Currently, only: `h264` and `aac` are supported.
6. Start Streaming!


## Manual MoQ Output Streaming Configuration

For configuring via a file, prior to launching OBS you can add this to your OBS Profile directory (eg: "Untitled"):
```bash
# Linux
$ cat ~/.config/obs-studio/basic/profiles/Untitled/service.json

# MacOS
$ cat ~/Library/Application\ Support/obs-studio/basic/profiles/Untitled/service.json

{
"type": "moq_service",
"settings": {
"server": "http://localhost:4443/",
"use_auth": false,
"bwtest": false,
"service": "MoQ",
"key": "anon/bbb"
}
}
```

## MoQ Source (experimental)

1. Open OBS Studio
2. Goto **Sources** > (right-click) **MoQ Source**
3. Enter your MoQ Server details, eg:
* For development (`just dev`): `http://localhost:4443/anon`.
4. Enter the broadcast name/path:
* For development: `bbb`.
5. Click **OK**


## Supported Build Environments

| Platform | Tool |
Expand All @@ -96,6 +133,8 @@ RUST_LOG=debug RUST_BACKTRACE=1 OBS_LOG_LEVEL=debug ../obs-studio/build_macos/fr
| Ubuntu 24.04 | `pkg-config`
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix table formatting: missing closing pipe character.

Line 133 is missing the closing pipe (|) at the end of the row.

🔎 Proposed fix for table formatting 
-| Ubuntu 24.04 | `pkg-config`
+| Ubuntu 24.04 | `pkg-config` |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Ubuntu 24.04 | `pkg-config`
| Ubuntu 24.04 | `pkg-config` |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

133-133: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

🤖 Prompt for AI Agents 
In README.md around line 133, the Markdown table row "| Ubuntu 24.04 |
`pkg-config`" is missing the trailing closing pipe; add the final "|" to the end
of the row so the table cell is properly terminated (change it to "| Ubuntu
24.04 | `pkg-config` |").

| Ubuntu 24.04 | `build-essential` |



## License

See the [LICENSE](LICENSE) file for details.