feat: use vcpkg only on Windows, system packages on Linux/macOS

Author: Sqhh99

.github/workflows/builds.yml

@@ -10,7 +10,7 @@ on:
       - client-sdk-rust/**
       - CMakeLists.txt
       - build.sh
-      - build.bat
+      - build.cmd
       - vcpkg.json
       - CMakePresets.json
       - .github/workflows/**
@@ -23,14 +23,15 @@ on:
       - client-sdk-rust/**
       - CMakeLists.txt
       - build.sh
-      - build.bat
+      - build.cmd
       - vcpkg.json
       - CMakePresets.json
       - .github/workflows/**
   workflow_dispatch:
 
 env:
   CARGO_TERM_COLOR: always
+  # vcpkg binary caching only needed for Windows
   VCPKG_BINARY_SOURCES: "clear;x-gha,readwrite"
 
 jobs:
@@ -56,13 +57,15 @@ jobs:
           fetch-depth: 0
 
       - name: Export GitHub Actions cache environment variables
+        if: runner.os == 'Windows'
         uses: actions/github-script@v7
         with:
           script: |
             core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
             core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 
-      - name: Setup vcpkg
+      - name: Setup vcpkg (Windows only)
+        if: runner.os == 'Windows'
         uses: lukka/run-vcpkg@v11
         with:
           vcpkgGitCommitId: 'c82f74667287d3dc386bce81e44964370c91a289'
@@ -79,14 +82,16 @@ jobs:
             libxext-dev libxcomposite-dev libxdamage-dev libxfixes-dev \
             libxrandr-dev libxi-dev libxkbcommon-dev \
             libasound2-dev libpulse-dev \
-            libssl-dev
+            libssl-dev \
+            libprotobuf-dev protobuf-compiler \
+            libabsl-dev
 
       - name: Install system deps (macOS)
         if: runner.os == 'macOS'
         run: |
           set -eux
           brew update
-          brew install cmake ninja
+          brew install cmake ninja protobuf abseil
 
       - name: Install Rust (stable)
         uses: dtolnay/rust-toolchain@stable

CMakeLists.txt

@@ -10,7 +10,13 @@ set(LIVEKIT_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 set(LIVEKIT_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
 option(LIVEKIT_BUILD_EXAMPLES "Build LiveKit examples" OFF)
-option(LIVEKIT_USE_VCPKG "Use vcpkg for dependency management" ON)
+
+# vcpkg is only used on Windows; Linux/macOS use system package managers
+if(WIN32)
+  option(LIVEKIT_USE_VCPKG "Use vcpkg for dependency management (Windows only)" ON)
+else()
+  option(LIVEKIT_USE_VCPKG "Use vcpkg for dependency management" OFF)
+endif()
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)

CMakePresets.json

@@ -14,7 +14,8 @@
           "type": "FILEPATH",
           "value": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
         },
-        "VCPKG_INSTALLED_DIR": "${sourceDir}/vcpkg_installed"
+        "VCPKG_INSTALLED_DIR": "${sourceDir}/vcpkg_installed",
+        "LIVEKIT_USE_VCPKG": "ON"
       }
     },
     {
@@ -33,8 +34,10 @@
     {
       "name": "linux-base",
       "hidden": true,
-      "inherits": "vcpkg",
       "generator": "Ninja",
+      "cacheVariables": {
+        "LIVEKIT_USE_VCPKG": "OFF"
+      },
       "condition": {
         "type": "equals",
         "lhs": "${hostSystemName}",
@@ -44,8 +47,10 @@
     {
       "name": "macos-base",
       "hidden": true,
-      "inherits": "vcpkg",
       "generator": "Ninja",
+      "cacheVariables": {
+        "LIVEKIT_USE_VCPKG": "OFF"
+      },
       "condition": {
         "type": "equals",
         "lhs": "${hostSystemName}",
@@ -55,14 +60,14 @@
     {
       "name": "windows-release",
       "displayName": "Windows x64 Release",
-      "description": "Build for Windows x64 Release",
+      "description": "Build for Windows x64 Release (vcpkg)",
       "inherits": "windows-base",
       "binaryDir": "${sourceDir}/build"
     },
     {
       "name": "windows-debug",
       "displayName": "Windows x64 Debug",
-      "description": "Build for Windows x64 Debug",
+      "description": "Build for Windows x64 Debug (vcpkg)",
       "inherits": "windows-base",
       "binaryDir": "${sourceDir}/build"
     },
@@ -80,13 +85,23 @@
     {
       "name": "linux-release",
       "displayName": "Linux Release",
-      "description": "Build for Linux Release",
+      "description": "Build for Linux Release (system packages)",
       "inherits": "linux-base",
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release"
       }
     },
+    {
+      "name": "linux-debug",
+      "displayName": "Linux Debug",
+      "description": "Build for Linux Debug (system packages)",
+      "inherits": "linux-base",
+      "binaryDir": "${sourceDir}/build",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
+    },
     {
       "name": "linux-release-examples",
       "displayName": "Linux Release with Examples",
@@ -95,20 +110,29 @@
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release",
-        "LIVEKIT_BUILD_EXAMPLES": "ON",
-        "VCPKG_MANIFEST_FEATURES": "examples"
+        "LIVEKIT_BUILD_EXAMPLES": "ON"
       }
     },
     {
       "name": "macos-release",
       "displayName": "macOS Release",
-      "description": "Build for macOS Release",
+      "description": "Build for macOS Release (Homebrew packages)",
       "inherits": "macos-base",
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release"
       }
     },
+    {
+      "name": "macos-debug",
+      "displayName": "macOS Debug",
+      "description": "Build for macOS Debug (Homebrew packages)",
+      "inherits": "macos-base",
+      "binaryDir": "${sourceDir}/build",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug"
+      }
+    },
     {
       "name": "macos-release-examples",
       "displayName": "macOS Release with Examples",
@@ -117,8 +141,7 @@
       "binaryDir": "${sourceDir}/build",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Release",
-        "LIVEKIT_BUILD_EXAMPLES": "ON",
-        "VCPKG_MANIFEST_FEATURES": "examples"
+        "LIVEKIT_BUILD_EXAMPLES": "ON"
       }
     }
   ],
@@ -142,6 +165,10 @@
       "name": "linux-release",
       "configurePreset": "linux-release"
     },
+    {
+      "name": "linux-debug",
+      "configurePreset": "linux-debug"
+    },
     {
       "name": "linux-release-examples",
       "configurePreset": "linux-release-examples"
@@ -150,6 +177,10 @@
       "name": "macos-release",
       "configurePreset": "macos-release"
     },
+    {
+      "name": "macos-debug",
+      "configurePreset": "macos-debug"
+    },
     {
       "name": "macos-release-examples",
       "configurePreset": "macos-release-examples"

DEPENDENCIES.md

@@ -8,7 +8,9 @@ The LiveKit SDK consists of two static libraries:
 - `livekit.lib` (or `liblivekit.a` on Unix)
 - `livekit_ffi.lib` (or `liblivekit_ffi.a` on Unix)
 
-**IMPORTANT**: Static libraries do NOT include system dependencies. You must link these system libraries in your final executable.
+**IMPORTANT**: 
+- **Windows**: All dependencies (protobuf, abseil) are included as DLLs in the distribution. You just need to copy them alongside your executable.
+- **Linux/macOS**: You must install protobuf and abseil via your system package manager (apt/brew). The SDK links dynamically against these libraries.
 
 ---
 
@@ -122,16 +124,37 @@ Also add `-ObjC` to **Other Linker Flags**.
 
 ## Linux Dependencies
 
-When linking on Linux, you must add OpenSSL:
+### Required System Packages
+
+First, install the required development packages:
+
+```bash
+# Ubuntu/Debian
+sudo apt install libprotobuf-dev protobuf-compiler libabsl-dev libssl-dev
+
+# Fedora/RHEL
+sudo dnf install protobuf-devel abseil-cpp-devel openssl-devel
+```
+
+### CMake Configuration
 
 ```cmake
+find_package(Protobuf REQUIRED)
+find_package(absl REQUIRED)
 find_package(OpenSSL REQUIRED)
 
 target_link_libraries(your_app PRIVATE
     # LiveKit static libraries
     livekit
     livekit_ffi
     
+    # Protobuf and Abseil (REQUIRED)
+    protobuf::libprotobuf
+    absl::log
+    absl::check
+    absl::strings
+    absl::base
+    
     # Linux system libraries (REQUIRED)
     OpenSSL::SSL
     OpenSSL::Crypto
@@ -146,6 +169,7 @@ g++ your_app.cpp \
     -I/path/to/livekit/include \
     -L/path/to/livekit/lib \
     -llivekit -llivekit_ffi \
+    -lprotobuf -labsl_log -labsl_strings -labsl_base \
     -lssl -lcrypto -lpthread -ldl
 ```
 

README.md

@@ -7,15 +7,14 @@ This SDK enables native C++ applications to connect to LiveKit servers for real-
 ## 📦 Requirements
 - **CMake** ≥ 3.20  
 - **Rust / Cargo** (latest stable toolchain)  
-- **vcpkg** (for dependency management)
 - **Git LFS** (required for examples)
   Some example data files (e.g., audio assets) are stored using Git LFS.
   You must install Git LFS before cloning or pulling the repo if you want to run the examples.
 
 **Platform-Specific Requirements:**
-- **Windows:** Visual Studio 2019 or later
-- **macOS:** System frameworks (CoreAudio, AudioToolbox, etc.) are automatically linked
-- **Linux:** See [README_BUILD.md](README_BUILD.md) for system dependencies
+- **Windows:** Visual Studio 2019+, vcpkg (dependencies bundled in distribution)
+- **Linux:** `sudo apt install libprotobuf-dev libabsl-dev libssl-dev`
+- **macOS:** `brew install protobuf abseil`
 
 ## 🧩 Clone the Repository
 
@@ -46,28 +45,28 @@ git submodule update --init --recursive
 
 **Windows:**
 ```powershell
-.\build.bat clean       # Clean CMake build artifacts
-.\build.bat clean-all   # Deep clean (C++ + Rust + generated files)
-.\build.bat debug       # Build Debug version
-.\build.bat release     # Build Release version
-.\build.bat verbose     # Verbose build output
+.\build.cmd clean       # Clean CMake build artifacts
+.\build.cmd clean-all   # Deep clean (C++ + Rust + generated files)
+.\build.cmd debug       # Build Debug version
+.\build.cmd release     # Build Release version
+.\build.cmd verbose     # Verbose build output
 ```
 
 ### Advanced Build (Using CMake Presets)
 
 For more control and platform-specific builds, see the detailed instructions in [README_BUILD.md](README_BUILD.md).
 
-**Prerequisites:**
+**Prerequisites (Windows only):**
 - Set `VCPKG_ROOT` environment variable pointing to your vcpkg installation
 
-```bash
-# Linux/macOS
-export VCPKG_ROOT=/path/to/vcpkg
-
+```powershell
 # Windows PowerShell
 $env:VCPKG_ROOT = "C:\path\to\vcpkg"
 ```
 
+**Prerequisites (Linux/macOS):**
+- Install system dependencies (see above)
+
 **Quick start:**
 ```bash
 # Windows