Installation

This guide covers how to install and set up the Godot-LiveKit GDExtension in your project.

Prerequisites

To build the extension from source, you will need:

• Python 3.x
• SCons (pip install scons)
• CMake (Optional, for advanced builds)

Platform-Specific Requirements:

• Linux: g++, curl, tar, unzip
• macOS: Xcode Command Line Tools, curl, tar, unzip
• Windows: MSVC (Visual Studio Build Tools) or MinGW-w64 (if cross-compiling from Linux/macOS)

Building from Source

This repository includes a custom build.sh script that automatically fetches the required LiveKit C++ SDK and godot-cpp prebuilt binaries, and compiles the extension.

1. Clone the repository:

   git clone https://github.com/NodotProject/godot-livekit.git
   cd godot-livekit
   

2. Run the build script for your platform:

   • Linux:

     ./build.sh linux
     

   • macOS:

     ./build.sh macos
     

   • Windows:

     ./build.sh windows
     

Once the build is complete, the compiled dynamic libraries (.so, .dylib, or .dll) and the LiveKit shared libraries will be placed in the addons/godot-livekit/bin/ directory.

Installation in Godot

Once you have built the extension from source, or downloaded a pre-built release:

1. Copy the addons/godot-livekit folder into your Godot project’s addons/ directory.
2. Enable the plugin from the Godot Editor: Project -> Project Settings -> Plugins.

You are now ready to start using LiveKit in your Godot project. Proceed to the Quickstart guide to see how to connect to a room.