https://github.com/rudderlabs/rudder-sdk-unity
Repo for RudderStack's Unity SDK. RudderStack is an open-source, warehouse-first Customer Data Pipeline and Segment-alternative. It collects and routes clickstream data and builds your customer data lake on your data warehouse.
https://github.com/rudderlabs/rudder-sdk-unity
analytics open-source unity unity3d-plugin
Last synced: 12 months ago
JSON representation
Repo for RudderStack's Unity SDK. RudderStack is an open-source, warehouse-first Customer Data Pipeline and Segment-alternative. It collects and routes clickstream data and builds your customer data lake on your data warehouse.
- Host: GitHub
- URL: https://github.com/rudderlabs/rudder-sdk-unity
- Owner: rudderlabs
- License: mit
- Created: 2019-10-15T07:52:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T21:55:54.000Z (over 2 years ago)
- Last Synced: 2025-07-13T17:05:35.269Z (12 months ago)
- Topics: analytics, open-source, unity, unity3d-plugin
- Language: Objective-C
- Homepage: https://www.rudderstack.com
- Size: 89.5 MB
- Stars: 4
- Watchers: 6
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# What is RudderStack?
[RudderStack](https://rudderstack.com/) is a **customer data pipeline** tool for collecting, routing and processing data from your websites, apps, cloud tools, and data warehouse.
More information on RudderStack can be found [here](https://github.com/rudderlabs/rudder-server).
## Getting Started with Unity SDK
Download the SDK plugin file: ```rudder-sdk-unity.unitypackage``` from the ```SDK``` directory and import it in your project.
## Initialize ```RudderClient```
Put this code under the ```Awake``` method of your main scene.
```
RudderConfig config = new RudderConfigBuilder()
.WithDataPlaneUrl()
.Build();
RudderClient rudderClient = RudderClient.GetInstance(, config);
```
## Send Events
A simple track event is as shown:
```
RudderMessage message = new RudderMessageBuilder()
.WithEventName("test_event_name")
.WithEventProperty("test_key_1", "test_value_1")
.WithEventProperty("test_key_2", "test_value_2")
.WithUserProperty("test_user_key_1", "test_user_value_1")
.WithUserProperty("test_user_key_2", "test_user_value_2")
.Build();
rudderClient.Track(message);
```
Other supported methods are ```Screen``` and ```Identify```.
For more details, check out our [documentation](https://docs.rudderstack.com/rudderstack-sdk-integration-guides/getting-started-with-unity-sdk).
## Contact Us
If you come across any issues while using the RudderStack Unity SDK, please feel free to [contact us](https://rudderstack.com/contact/) or start a conversation on our [Slack](https://resources.rudderstack.com/join-rudderstack-slack) channel. We will be happy to help you.