https://github.com/getsentry/sentry-godot

WIP Godot SDK
https://github.com/getsentry/sentry-godot

godot godot-engine tag-production team-gdx

Last synced: 4 months ago
JSON representation

WIP Godot SDK

• Host: GitHub
• URL: https://github.com/getsentry/sentry-godot
• Owner: getsentry
• Created: 2024-09-13T14:52:03.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-26T10:35:45.000Z (4 months ago)
• Last Synced: 2024-10-27T03:32:16.992Z (4 months ago)
• Topics: godot, godot-engine, tag-production, team-gdx
• Language: C++
• Homepage:
• Size: 139 KB
• Stars: 3
• Watchers: 29
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

```bash

# install scons

python -m pip install scons

# upgrade scons

python -m pip install --upgrade scons

```

### Compiling

1. Clone repository and its submodules.

2. Build GDExtension libraries:

    ```bash

    # 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/libsentrysdk.*.editor.*`.

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

    ```bash

    # build *export* library for the current platform

    scons target=template_release debug_symbols=yes

    ```

3. Open demo project in Godot Engine:

    ```bash

    # 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`.