https://github.com/embrace-io/embrace-unity-sdk
Embrace's SDK for Unity
https://github.com/embrace-io/embrace-unity-sdk
mobile opentelemetry unity
Last synced: 8 months ago
JSON representation
Embrace's SDK for Unity
- Host: GitHub
- URL: https://github.com/embrace-io/embrace-unity-sdk
- Owner: embrace-io
- License: apache-2.0
- Created: 2024-02-05T16:58:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-05T21:51:15.000Z (about 1 year ago)
- Last Synced: 2025-05-05T22:39:31.896Z (about 1 year ago)
- Topics: mobile, opentelemetry, unity
- Language: C#
- Homepage: https://embrace.io/docs/unity/
- Size: 198 MB
- Stars: 58
- Watchers: 10
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
Embrace's Unity SDK lets you bring the deep, introspective and native debugging
power of Embrace into your Unity game or application.
[](https://codecov.io/gh/embrace-io/embrace-unity-sdk-internal)
## Getting Started
The Unity documentation can be found [here](https://embrace.io/docs/unity/).
- [Go to our dashboard](https://dash.embrace.io/signup/) to create an account
and get your API key
- Check our [guide](https://embrace.io/docs/unity/integration/) to integrate the
SDK into your Unity project
## Building
It is important to note that the Unity SDK is not usable immediately after
cloning the repository. This is because it depends directly on the
[Apple SDK](https://github.com/embrace-io/embrace-apple-sdk), and statically
links to the xcframeworks as part of the build process.
To build the SDK, run the following command from the root of the project:
```bash
make
```
This will automatically pull down the dependencies and build the Unity
xcframeworks, and copy everything into the io.embrace.sdk folder. Unfortunately,
it is not currently possible to invoke the required iOS specific commands on
Windows. This pipeline requires xcpretty (`gem install xcpretty`) and the XCode
Build Tools to be installed.
If you run into any issues building the SDK locally, please reach out on our
[community Slack](https://embraceio-community.slack.com/archives/C078WQ3DJMC)!
## Usage
- Refer to our [Features page](https://embrace.io/docs/unity/features/) to learn
about the features Embrace SDK provides
## Support & Contributions
We appreciate any feedback you have on the SDK and the APIs that it provides.
To contribute to this project please see our [Contribution Guidelines]. After
completing the Individual Contributor License Agreement (CLA), you'll be able to
submit a feature request, create a bug report, or submit a pull request.
For urgent matters (such as outages) or issues concerning the Embrace service or
UI, reach out in our [Community Slack] for direct, faster assistance.
[Contribution Guidelines]:
https://github.com/embrace-io/embrace-unity-sdk/blob/main/CONTRIBUTING.md
[Community Slack]: https://community.embrace.io
## License
[](./LICENSE.txt)
Embrace Unity SDK is published under the Apache-2.0 license.
See the
[LICENSE](https://github.com/embrace-io/embrace-unity-sdk/blob/main/LICENSE.txt)
for full details.