This SDK is actively evolving and may still be incomplete. It is developed as a C++ GDExtension library, building on top of existing Sentry SDKs, such as sentry-native. We are also considering adding support for compilation as a custom module. Let us know what you think!
Pre-built extension libraries with the demo project are available in Releases.
Check the official Sentry SDK documentation to get started.
In the Godot editor, you can adjust options by going to Project Settings -> Sentry -> Options. Feel free to explore the demo project/ for usage examples.
Godot Sentry SDK can be built for Windows, Linux, and macOS platforms (x86_64 for PC, and universal arch for Mac).
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 sconsOr, on a Mac:
brew install scons
-
Clone this repository
-
Restore submodules:
git submodule update --init --recursive -
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 -
Open demo project in Godot Engine:
# open demo project in Godot 4.3 godot project/project.godot
We appreciate your contributions! Feel free to open issues for feature requests and ask questions in Discussions. Your feedback is very much welcome!
Check out our Contributing Guide.