Godot

Learn how to integrate ByteBrew's light-weight Godot SDK.

Godot SDK Integration

tag Watch Video play_circle

Follow the steps below to integrate the ByteBrew SDK or watch the tutorial video for a step by step walkthrough:

Step 1

Import ByteBrew Godot Package to your project

Extract the contents of the Android folder from the zip:

ByteBrew.gdap

bytebrew_godot.release.aar

Place the two files listed above in your project file path res://android/plugins. If you dont have this path, then create it in the root of your project file.

Extract the contents of the iOS folder from the zip:

ByteBrew folder

Place the folder listed above in your project file path res://ios/plugins. If you dont have this path, then create it in the root of your project file.

Step 2

Enable ByteBrew in Project

Follow these steps to enable ByteBrew in Project:

Go to Project

Then Export, and select your Android export settings.

Scroll down to the Plugins section and enable ByteBrew by checking it.

Then Export, and select your iOS export settings.

Scroll down to the Plugins section and enable ByteBrew by checking it.

(iOS only optional) Step 3

Add AutoLoad script

Follow these steps to add a AutoLoad ByteBrew script in the Project:

Go to Project Settings

Then AutoLoad, and select your path folder button.

Find the res://ios/plugins/ByteBrew folder and select the ByteBrewEntry.gd script.

Then select Add, to your new AutoLoad Node.

Step 4

Go to your ByteBrew Dashboard

Go to your Game Settings page on the ByteBrew dashboard and locate your game keys listed on the dashboard. After finding your Game IDs and SDK Key, copy them.

Step 5

Initialize ByteBrew

Initialize ByteBrew using the code below at the first scene of your game to start capturing sessions and events.

Inside the initialization, input the Game ID and SDK Key from the ByteBrew dashboard into the parameters of the ByteBrew initialization.

notification_importantImportantPlace your initialization on the first scene of your game. ByteBrew SDK does not support offline event caching.

                                
                                
                                

                                var ByteBrew

                                func _ready():
                                    if Engine.has_singleton("ByteBrew"):
                                        ByteBrew = Engine.get_singleton("ByteBrew")
                                        //You must make sure add the last two parametes the Godot Version and your current version of your project so you can get deep cohort analytics.
                                        if OS.get_name() == "Android":
                                            ByteBrew.InitializeByteBrew("ANDROID GAME ID", "ANDROID GAME KEY", Engine.get_version_info(), "YOUR GAME VERSION HERE ex(0.0.1)")
                                        elif OS.get_name() == "iOS":
                                            ByteBrew.InitializeByteBrew("IOS GAME ID", "IOS GAME KEY", Engine.get_version_info(), "YOUR GAME VERSION HERE ex(0.0.1)")

Step 6

Exporting Android Requirements

ByteBrew requires the following implementation for Android:

Play Services Ads Identifier

We have already added requirements in the settings to add this implementation.

Step 6

Exporting iOS Requirements

To export for iOS, ByteBrew requires the following three (3) iOS Frameworks:

Security.Framework

AdServices.Framework

AdSupport.Framework

Each of these listed frameworks should be implemented in your final xcode project as frameworks.

Custom Events Tracking

tag

Custom Events in ByteBrew enable you to deep dive across all of our extensive analytics dashboards. Continue below to learn how to integrate custom events.

Custom Events on ByteBrew allow for an unlimited number of key_name=value; sub-parameters under the custom event. For example, you can have a custom event called “level” that has a subparameter under the event named “levelnumber” and the values of that Level Number subparameter could be “1, 2, 3, 4, 5, etc.”. Additionally you could add in other subparameters for attributes inside the levels of your game, such as "powerups", to show the different equipment used in levels with parameter values "fireball, revive, doublepoints, etc.". The world is your oyster with custom events, so build as complex of an event system as you need for your game. To illustrate our custom event structure visually, see the following diagram:

notification_importantImportant Do not replicate or copy/paste event structures from other analytics providers to ByteBrew, this will lead to malformed event reporting. Follow ByteBrew's event structure in the following documentation.

Custom Events

See samples below to see how to code Custom Events:

notification_importantImportant Do not use (1) spaces, (2) periods ".", or (3) colons ":" in your custom events. As an alternative to spaces in custom events, use "_". Ex. "key_name=value;".

Custom event names that include (1) spaces, (2) periods "." or (3) colons ":" will not be processed on the dashboard. These events are unrecognized by ByteBrew and antipattern to ByteBrew's event structure.

For parameters under custom events, do not use spaces.

Basic Custom Event:

                                
                      
                                    //Basic Custom Event without any sub-parameters
                                    ByteBrew.NewCustomEvent("eventName")

                                    //Basic Custom Event with a sub-parameter
                                    ByteBrew.NewCustomEventWithStringValue("CustomEventName", "key_name=value;")

                                    //Examples 
                                    ByteBrew.NewCustomEventWithStringValue("GamePurchaseVC", "currency=GOLD;amount=500;character=viking;")
                                    ByteBrew.NewCustomEventWithStringValue("LevelCompleted", "level=25;character=viking;")

Custom Event Tracking Method:

                                
                                
                                    
                                    

                                //Key Value format "key_name=value;"
                                //Custom Events can take multiple pairs, "key_name1=value1;key_name2=value2;key_name3=value3;"
                                ByteBrew.NewCustomEventWithStringValue("level_started", "weapon=megablaster;powerup=extralife;")

Remote Configs & A/B Tests

tag

Remote Configs allow you to make updates to your app remotely without having to update your game's app store. Adding remote configs to your games are a fantastic way to be agile and send updates or patches to players instantly. Remote Configs are also utilized for creating A/B Tests on the platform.

When planning to integrate Remote Configs, We recommend implementing remote configs throughout all parts of your game to allow you to tweak and tune as you analyze your game performance data. See how to implement remote configs in your game by following the steps below:

notification_importantImportant Do not spam config calls in your app code. Apps that spam remote configs calls with behavior such as: calling configs each game frame, or rapidly firing multiple calls per user will be auto flagged and potentially paused.

Loading the Remote Configs

To use Remote Configs, you must first call for the config to get updated. You can call the below code whenever you want to update the configs:

infoNote ByteBrew automatically calls LoadRemoteConfig on initialization but you can call it again when needed.

                                
                                
                                
                                //Call the loader to update configs 
                                ByteBrew.LoadRemoteConfigs()

                                //Check if the remote configs are ready and set
                                ByteBrew.HasRemoteConfigsBeenSet()

You can grab A/B Test keys and values using this method:

infoNote If the user is part of the control group it won't return anything but the default parameter value set.

                                
                                

                                //Call to get the key specific value and if the key doesn't exist it will return the default variable specified, like if the AB test user is in the control group
                                var configValue = ByteBrew.RetrieveRemoteConfigValue("KEY", "DEFAULT VALUE IF NOT AVAILABLE")

Push Notifications

tag Watch Video play_circle

Using ByteBrew you can send cross-platform push notifications to your players around the globe. To get started with push notifications follow the steps below or watch the tutorial video series.

infoNote If you are using Push Notifications in ByteBrew, you must first call InitializeByteBrew before calling StartPushNotification.

notification_importantImportantIn addition to setting up Push Notifications in the SDK, there is additional setup required on the ByteBrew dashboard to get up and running. Visit the Push Notifications documentation page for all the steps to get step.

Step 1

Integrate Push Notifications

Integrating Push Notifications with ByteBrew is super simple and only requires one line of code after initializing the ByteBrew SDK. See the Push Notification integration code line below:

                                
                                
                                                            
                                
                                ByteBrew.StartPushNotifications()

Step 2

Create Push Notification App on the ByteBrew Dashboard

Go to the Push Notification dashboard on ByteBrew and create a new Push Notification App. See our Push Notification Dashboard documentation for step by step walkthroughs about this.

infoNote In order to create a push app, you must first create an game or app on the ByteBrew dashboard.

Push Notification Extra Settings (Optional Android Only)

Add a Custom Small Icon and Large Icon for push notifications.

infoNote The small icon automatically defaults to your app icon. We recommend that you add a small icon because your app icon may not appear correctly. If the large icon default is none, it will not show.

notification_importantImportantMake sure to add these icons to your res android folder. Keep note of the name of the icon, so you can set them in the dashboard when creating a notification.

Push Notification Android Manifest (Required Android Only)

notification_importantImportantIf your app targets Android API Level 33 and above, make sure your implement this manifest permission.

                                
                                    <uses-permission android:name="android.permission.POST_NOTIFICATIONS"/>

Push Notification Xcode Export Additions (Required iOS Only)

For sending notifications to iOS devices, follow the additional required steps below on Xcode:

infoNote For the best step by step walkthrough on push notification integration, watch the video tutorial series on the ByteBrew Youtube Channel.

Step 1

Add UserNotifications.framework

Add UserNotifications.framework to the frameworks and libraries in Xcode.

Step 2

Add Capabilities

Press "+ Capability" and add the following capabilities listed in steps 3 and 4 below.

Step 3

Add "Background Modes" and under that section, checkmark "Remote Notifications

Step 4

Add "Push Notifications"

Track Purchases

tag

In ByteBrew SDK you can track all your game or apps in-app purchases to analyze your monetization performance on the dashboard. There are two ways to track purchases on ByteBrew. The first way is to use basic in-app purchase events. The second way is to use our real-time server-side purchase validation to validate real purchases vs. fraudulent transactions.

Track Basic In-App Purchases

To track in-app purchases in your game, use the below method:

                                
                                
   
                                
                                
                                ByteBrew.TrackInAppPurchaseEvent("Apple App Store", "USD", float(amount), "currencyPack01", "Currencies")

Track Validated Purchases

On ByteBrew, we offer a real-time server-side purchase validation to stop purchase fraud from client-side purchase receipt tampering that takes place in mobile games and apps.To track validated in-app purchases utilize the following platform specific method:

notification_importantImportantMake sure the receipts have correct JSON string formatting.

                                

                                
                                //JSON Format ex. string json = "{\"firstname\":\"john\", \"lastname\":\"doe\",\"age\":30}";
                              
                                //Retrieve the Android receipt and Signature from the purchase event that occurs. We will validate it server side so you can view valid purchases in you dashboard.
                                var googleReciept = "..."
                                var googleSignature = "..."
                                ByteBrew.TrackGoogleInAppPurchaseEvent("Google Play Store", "USD", float(amount), "currencyPack01", "Currencies", googleReciept, googleSignature)

Ad Tracking Event

tag

Using ByteBrew you can track your game's or app's ad events. Tracking Ad Events will enable you to see breakdowns of your ads in the monetization dashboard. See the code snippets below to learn how to track ad events:

infoNoteTracking Ad Events in the ByteBrew SDK is required for visualizing pLTV and pROAS calculations on the Attribution dashboard.

                                
                                
                                
                                // Record the Placement Type, Location of the placement, ad unit ID, and Network (Recommended)
                                ByteBrew.TrackAdEventWithAllOptions("Interstitial", "EndOfLevel", "3253k3302-3r3j4i343-3nij343-405403", "AdMob")

                                //Some ad event paramters can be ommited like so
                                ByteBrew.TrackAdEvent("Interstitial", "EndOfLevel")
                                ByteBrew.TrackAdEventWithAdID("Interstitial", "EndOfLevel", "3253k3302-3r3j4i343-3nij343-405403")

Custom User Data Attributes

tag

Data attributes are tags in the SDK that you can give a user to define them more specifically on the dashboard when filtering. For example, you can use data attributes to tag to users to build player segments to send targeted push notifications. If you are looking to update values on users at certain locations of your game, then use Custom Events with subparamters to track that type of update. See the following code snippets for examples on how to use Custom User Data Attributes:

infoNote Custom Data Attributes should not be spammed or used to continuoisly update a set of values a single user. If our system detects or tracks that your game(s) are spamming this method, it will automatically turn off your Custom Data Attribute tracking.

                                
                                
                                
                                
                                ByteBrew.SetCustomDataWithStringValue("username", "michael_scarn")
                                ByteBrew.SetCustomDataWithDoubleValue("total_hitpoints", 68.7)
                                ByteBrew.SetCustomDataWithIntegerValue("dundees", 3)
                                ByteBrew.SetCustomDataWithBooleanValue("loves_the_office", true)

Progression Event Tracking

tag

Progression events are a great way to track linear event stages in your game to measure how players are transitioning through levels or worlds. See below for the list of progression event parameters and code snippets for progression events.

ProgressionType

The type of progression event. Must be one the following options:

fiber_manual_record

Started

fiber_manual_record

Completed

fiber_manual_record

Failed

Environment

Area or World in the game the event is located such as: Tutorial, Arena, or Level. You can choose how to define the environments in your game or app.

Stage

The stage of the environment that the event takes place in such as: king_arena, jungleLevel, or level_02. You can define how to define the stages in your game or app.

Value

The value of the event. This can be a string or float value attached to the event.

                                

                                
 
                                //Example Progression event where the user started a tutorial in arena 0 or first arena
                                ByteBrew.NewProgressionEvent("Started", "Tutorial", "arena0")

                                //Example progression event where the user has completed the kings arena and could be rewarded with 3 crowns
                                ByteBrew.NewProgressionEventWithFloatScore("Completed", "Arena", "kings_arena", float(3))

Get User ID

tag

GetUserID method in the SDK enables you to grab the current User ID of the user in your game. This is a handy method for finding the ID for a user you want to send a specific push notification to.

                                
                                
                                
                                
                                
                                // Get the string userID
                                ByteBrew.GetUserID()

Stop Tracking Current User

tag

In the ByteBrew SDK, you have the option to stop tracking any user in your game by calling the ByteBrew StopTracking method. This will immediately stop and disable any tracking for a user. As another alternative method to disabling tracking, you can build your own consent pop-up prompt screen in your game or app and delay the initialization of ByteBrew SDK until your user has consented/agreed to your prompt.

                                
                                
                                
                                
                                
                                ByteBrew.StopTracking();

SDK FAQs

What is the minimum OS versions required for ByteBrew SDK?

ByteBrew supports Android 5.1 and above.

Can I use two push notification providers at once?

No, you can only use one push notification service or provider to send notifications at one time. However, if you are only using ByteBrew for our other services, then you can use another platform's push notifications SDK while still using ByteBrew SDK without any issues.

Is there any callback needed for Push Notifications?

No, Push Notifications has it's own internal callback, so no other callback is necessary.

What is the minimum Android API version for ByteBrew?

API Level 22 (Android 5.1)

How long does it take for my Configs or my A/B Test to deliver to my players?

A/B Tests deliver configs using your Remote Configs integration. Remote Configs delivered in milliseconds to your players after the ByteBrew SDK is initialized.

Need some help?

Join the ByteBrew Discord community to chat with our team and other developers on the platform.

Go to Discord arrow_outward

lightbulb Pro Tip Initialize ByteBrew in the first scene of your app or game.