Installation

On this page you’ll learn how to install saucer through any of the officially supported ways.

Prerequisites

Before installing saucer, ensure your development environment meets the following requirements:

• A C++23 compatible compiler
• CMake (recommended installation method)

Dependencies

Saucer relies on certain system-level dependencies to run.
These dependencies are usually pre-installed on the respective platform.

Windows

On Windows the WebView2 Runtime is required, which comes pre-installed since Windows 11.

MacOS

Saucer uses Cocoa and WKWebView on MacOS, which are both part of the operating system.

Linux

Saucer supports both WebKitGtk and Qt on Linux.

The default backend is WebKitGtk, but it can be configured through the saucer_backend CMake-Option.

Both are well established in the Linux world and most systems have either of them installed already. In case you have neither installed on your system, you may refer to your distribution on how to install the following packages:

Caution

Package names may differ on your distribution!

WebKitGtk

• gtk4
• webkitgtk-6.0

Qt

• qt6-qtwebengine
• qt6-qtwebchannel
• qt6-qtbase-gui
• qt6-qtbase

Installation Methods

CPM (Recommended)

CPMAddPackage(
  NAME           saucer
  VERSION        v8.0.2
  GIT_REPOSITORY "https://github.com/saucer/saucer"
)

target_link_libraries(${PROJECT_NAME} [PRIVATE|PUBLIC] saucer::saucer)

See: CPM.cmake Installation Instructions

FetchContent

FetchContent_Declare(
  saucer
  GIT_REPOSITORY https://github.com/saucer/saucer
  GIT_TAG        v8.0.2
)

FetchContent_MakeAvailable(saucer)

target_link_libraries(${PROJECT_NAME} [PRIVATE|PUBLIC] saucer::saucer)

Pre-Built

Caution

This method is strongly discouraged and not officially supported. Use CMake whenever possible.

The GitHub Workflows automatically produce a pre-built artifact for Windows that you can link against manually.

TypeScript

For those who plan on using saucer for serving their own frontend, we recommend to install the @saucer-dev/types package, which provides typed abstractions over all saucer functions.

Caution

When using the typescript package, you should not access saucer functions through saucer.something and instead import them from the package.
E.g. instead of using saucer.call, import call from import { call } from "@saucer-dev/types";