> For the complete documentation index, see [llms.txt](https://docs.candy-smith.com/main/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.candy-smith.com/main/general-info/analytics/bytebrew.md).

# bytebrew

Use ByteBrew when the buyer's project uses the ByteBrew analytics platform.

## ByteBrew setup

{% stepper %}
{% step %}

### Import the official ByteBrew Unity SDK

{% endstep %}

{% step %}

### Create a ByteBrew GameObject

Open:

```
Window > ByteBrew > Create ByteBrew GameObject
```

{% endstep %}

{% step %}

### Keep one ByteBrew GameObject

Keep exactly one ByteBrew GameObject in the first scene.
{% endstep %}

{% step %}

### Open ByteBrew settings

{% endstep %}

{% step %}

### Enable the target platforms

{% endstep %}

{% step %}

### Copy the buyer's platform-specific Game IDs

Copy the Game IDs from the ByteBrew Dashboard.
{% endstep %}

{% step %}

### Copy the buyer's SDK Key

Copy the SDK Key from the ByteBrew Dashboard.
{% endstep %}

{% step %}

### Enter the values in the ByteBrew settings inspector

{% endstep %}

{% step %}

### Add the SDK define if needed

If the installed package does not define it automatically, add:

```
BYTEBREW_SDK
```

{% endstep %}

{% step %}

### Select ByteBrew in GameSettings

Select `ByteBrew` in `GameSettings`.
{% endstep %}
{% endstepper %}

## ByteBrew IDs and SDK Key

The following values belong in ByteBrew settings:

* Android Game ID
* iOS Game ID
* Web Game ID, if applicable
* SDK Key

{% hint style="warning" %}
Do not add these values to:

* `GameSettings`
* HomeDesignMatch3Kit source files
* the analytics provider code
  {% endhint %}

The provider:

* Sends common events as ByteBrew custom events.
* Converts common analytics parameters to strings.
* Ignores events raised before ByteBrew initialization is complete.

This integration does not use offline event caching for ByteBrew.

{% hint style="info" %}
The Unity Analytics Schema Setup Wizard is not required for ByteBrew.
{% endhint %}

## Official documentation

* [ByteBrew Unity SDK](https://docs.bytebrew.io/sdk/unity)
* [ByteBrew App Settings](https://docs.bytebrew.io/dashboard/gamesettings)