Skip to content

getsentry/sentry-godot

Repository files navigation

Sentry for Godot Engine

This SDK is a work in progress

Building Sentry Godot SDK

Godot Sentry SDK can currently be built for Windows and Linux platforms.

Setting up SCons

Prerequisites: SCons, CMake, C/C++ compiler, python, clang-format.

On Windows, if you have scoop installed, you can easily install most of the required packages with the following command:

scoop install python scons cmake clang

You can also use an existing Python installation to install SCons build tool:

# install scons
python -m pip install scons

# upgrade scons
python -m pip install --upgrade scons

Or, on a Mac:

brew install scons

Compiling

  1. Clone this repository

  2. Restore submodules: git submodule update --init --recursive

  3. Build GDExtension libraries:

    # build *editor* library for the current platform
    # run from the repository root dir
    scons target=editor debug_symbols=yes

    The build process should produce a GDExtension library file for the editor target at project/addons/sentrysdk/bin/....

    To export a project in Godot that uses this extension, you'll also need the libraries for the export templates:

    # build *export* library for the current platform
    scons target=template_release debug_symbols=yes
  4. Open demo project in Godot Engine:

    # open demo project in Godot 4.3
    godot project/project.godot

In the Godot editor, you can adjust the Sentry SDK settings by going to Project Settings -> Sentry -> Config.