Skip to content

chore: Improve and update README #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 23, 2025
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .github/issue_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 22 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Sentry for Godot Engine

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](https://github.com/getsentry/sentry-native). We are also considering adding support for compilation as a [custom module](https://docs.godotengine.org/en/stable/contributing/development/core_and_modules/custom_modules_in_cpp.html). [Let us know](https://github.com/getsentry/sentry-godot/discussions) what you think!
Sentry for Godot helps you monitor your game's health after release. It provides insights into crash reports, script errors, hardware information, user feedback, and more through an intuitive web dashboard. With automatic error reporting, release tracking, and AI-assisted analysis, you can quickly identify, prioritize, and resolve issues for better player experience.

**Architecture**: Built as a C++ GDExtension library using mature Sentry SDKs like [sentry-native](https://github.com/getsentry/sentry-native) as the foundation.

![issue-example](./.github/issue_example.png)

🚧 **Preview Phase** - This SDK is currently in 1.0 preview phase as we work towards a stable 1.0.0 release. While functional, some features may be incomplete, subject to change or missing.

**Feedback Welcome**: We'd love to hear about your experience! Share feedback and ask questions in [Discussions](https://github.com/getsentry/sentry-godot/discussions).


## Minimum supported Godot Engine
Expand All @@ -10,64 +18,27 @@ This SDK is actively evolving and may still be incomplete. It is developed as a
| `1.x` releases | Godot 4.5 or later |
| `0.x` releases | Godot 4.3 or later |

## Supported platforms and architectures

- **Windows**: x86_64, x86_32
- **Linux**: x86_64, x86_32
- **macOS**: universal (Intel and Apple Silicon)
- **Android**: arm64, arm32, x86_64
- **iOS**: coming soon

Support for additional platforms and architectures may be added in future releases.

## Getting started

Pre-built extension libraries with the demo project are available in [**Releases**](https://github.com/getsentry/sentry-godot/releases).
Pre-built extension libraries with the demo project are available in [**Releases**](https://github.com/getsentry/sentry-godot/releases), including 1.0.0 pre-release versions.

Check the official [Sentry SDK documentation](https://docs.sentry.io/platforms/godot/) 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.

## Building Sentry Godot SDK

Godot Sentry SDK can be built for Windows, Linux, macOS, and Android platforms (x86_64 for PC, universal for Mac, arm64/32 and x86_64 for Android).

### 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
```
Or, on a Mac:

```
brew install scons
```

### Compiling

1. Clone this repository
2. Restore submodules: `git submodule update --init --recursive`
3. 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/sentry/bin/...`.

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
```
4. Open demo project in Godot Engine:
```bash
# open demo project in Godot 4.3
godot project/project.godot
```
## Building from source

For build instructions, see our [**Contributing Guide**](https://github.com/getsentry/sentry-godot/blob/master/CONTRIBUTING.md#building-sdk).

## Contributing

Expand Down
Loading