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.

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

Saucer supports both WebKitGtk and Qt (5 & 6) 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:

WebKitGtk
Qt

gtk4
webkitgtk-6.0

Installation Methods

1
CPMAddPackage(
2
  NAME           saucer
3
  VERSION        v7.0.0
4
  GIT_REPOSITORY "https://github.com/saucer/saucer"
5
)

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

See: CPM.cmake Installation Instructions

1
FetchContent_Declare(
2
  saucer
3
  GIT_REPOSITORY https://github.com/saucer/saucer
4
  GIT_TAG        v7.0.0
5
)
6

7
FetchContent_MakeAvailable(saucer)

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

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.