Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
limbonaut committed Oct 11, 2024
1 parent 18c3607 commit 21865ae
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,36 @@

An eventual Godot SDK for Sentry

## Build steps (work-in-progress)
## Compiling Sentry Godot SDK

Prerequisites: cmake, scons, C/C++ compiler, clang-format, libcurl(?).
Sentry Godot 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
```

### Build steps

1. Clone repository and its submodules.
2. Build sentry-native (libsentry and crashpad):
```bash
cd sentry-native
# configure CMake build as a static library in the `build-static` directory
cmake -B build-static -DSENTRY_BUILD_SHARED_LIBS=OFF -DCMAKE_BUILD_TYPE=RelWithDebInfo
# build libsentry and crashpad
cmake --build build-static --parallel
```
3. Copy crashpad_handler executable into `project/addons/sentrysdk/bin/`
4. Build GDExtension libraries:
2. Build GDExtension libraries:
```bash
# build *editor* library for the current platform
# run from the repository root dir
scons target=editor
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 libraries for the export templates:
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
scons target=template_release debug_symbols=yes
```
5. Open demo project in Godot Engine:
3. Open demo project in Godot Engine:
```bash
# open demo project in Godot 4.3
godot project/project.godot
Expand Down

0 comments on commit 21865ae

Please sign in to comment.