Integrating the GameAnalytics SDK with Roblox

Integrating GameAnalytics with Roblox

GameAnalytics has developed a Roblox SDK for integrating their platform with your games. GameAnalytics is a powerful analytics tool that will help you understand player behavior, improve engagement, retain players, and increase monetization.

Developers have been talking recently about the advantages of using event-based analytics to help improve your games with a recent series of Analytics articles, starting with an Introduction to Analytics and most recently discussing how to design for engagement. With GameAnalytics supported Roblox SDK, you now have a powerful and easy way to implement analytics in your game.

Why GameAnalytics?

GameAnalytics gives you access to data that you can use to inform your development decisions. If you want to bring your game to the next level, using and understanding event-based analytics is critical. GameAnalyticsā€™s analytical tools and platform allow you to gain insights into player behavior and how your content is performing. For example, you can find out what items sell the best in your game, where new players get confused and stop playing, what content players engage with the most, and more. You can also compare your key metrics against those of over 19,000 games (both Roblox and non-Roblox!) across the platform to understand how well your game is doing.

You can set up GameAnalytics for free in just a few short minutes. If you want to check out the platform before integrating it with your own game, thereā€™s a nifty demo game with pre-populated data available when you sign up.

The SDK from GameAnalytics can be installed in 3 short steps.

Step 1: Create a GameAnalytics account

Sign up for a free GameAnalytics account and add your game. After youā€™ve created your game, youā€™ll find the integration keys in the settings menu (the gear icon) under ā€œGame information.ā€ Copy your Game Key and Secret Key for the following steps.

Step 2: Install the GameAnalytics SDK for Roblox

Method 1: GitHub ZIP installation

  1. Download the GameAnalytics SDK for Roblox GitHub ZIP
  2. Unzip the ZIP file
  3. Inside Roblox Studio, right-click on Workspace. Click ā€œInsert from fileā€¦ā€ and select the unzipped .rbxmx file.

Method 2: Roblox module page installation

  1. On the GameAnalytics Roblox module page click on the ā€˜Getā€™ button.
  2. Inside Roblox Studio, select Workspace, open the Toolbox and select My Models.
  3. Click on the GameAnalytics module to add it to Workspace.

Regardless of which method you use, once the module has been installed inside Roblox Studio:

  1. Move the GameAnalytics script (together with its children) under ServerStorage
  2. Move the GameAnalyticsScript script under ServerScriptService
  3. Move the GameAnalyticsClient script under StarterPlayer/StarerPlayerScripts

It should look something like this:
image

Step 3: Initialize the integration

The final step involves adding the code to activate the SDK. There are 3 phases for this step:

  1. Configuration 1

The configuration calls configure settings for the SDK. These settings cannot be altered after initialize has been called._

  1. Initialization

The initialize call will start the SDK and activate the first session._

  1. Adding events or changing dimensions

The configuration and initialization steps should be called when your game starts.

If you want to learn more about configuring and initializing the SDK, GameAnalytics has put together a Roblox SDK guide, which has a ton of details and useful code to help you get started.

Once the SDK has been configured and initialized, the final step involves adding events in your game code where some relevant action is happening.

GameAnalytics has some useful resources for learning about data and events:

Data and Events - what are events and how are they useful?
Designing Custom Events - learn how to structure your events
How to Implement Event Tracking - how to track events in your game

Viewing your game data

Once youā€™re all set up, youā€™ll find insights into more than 50 of the top gaming Key Performance Indicators (KPIs) straight out of the box. Many of these metrics are viewable on a real-time dashboard to get a quick overview of the health of your game throughout the day.

image

Cool features youā€™ll find in GameAnalytics

At this point, Iā€™m sure youā€™re itching to dive straight into GameAnalytics and start experimenting. Before you do, I want to quickly show you some of the things you can do:

Dashboards

Using the dashboards, youā€™ll be able to get accurate insights into all of your most pressing questions. These dashboards can be customized, so you can see the metrics that matter most to you.

image

Real-time

You can track real-time player data and behavior with the Real-time feature. This feature is useful for tracking concurrent users and key metrics after updates or during featuring and game events to make sure everything is going smoothly.

image

Explore

Using the explore tool you can be as creative as you want with your player data, before customizing the graphs on your dashboards. Select metrics, apply filters, and visualize your results in unique ways that benefit you.

image

Segments

Here youā€™ll be able to accurately target specific groups of players (or segments) by geography, specific player attributes, or by similar behaviors in your game.

image

Funnels

Funnels allow you to learn how your players are progressing through specific levels or flows in your game and where they falter. Funnel analysis is particularly useful for figuring out issues with your gameā€™s engagement or retention.

image

Cohorts

Use cohorts to see metrics relating to a specific audience and track their changes over time so you can find out how well a particular campaign, promotion, or in-game update is doing.

image

You can find a more detailed overview for each dashboard on the GameAnalytics documentation portal.

If you have any questions or problems, feel free to post a reply below. Iā€™ll try my best to help as much as possible.

Thanks for reading!

98 Likes

Funny, I was thinking about this just yesterday!

Thank you for writing this, Iā€™m using this SDK pretty soon and having this here to guide me helps.

4 Likes

I tried to setup GameAnalytics a while back, but there were bugs with the website for me. I contacted their support team and by the dayā€™s end it was fixed and I was able to use it.

I havenā€™t really used it in any legitimate projects, and I plan to do so; if anyone can enlighten me on any possible alternatives, and where I can find a comparison to other analytical services (for Roblox), please reply or message me as it can really help myself and other developers :slightly_smiling_face:

2 Likes

Are these Top 50 KPIs automatically tracked as soon as you install the SDK?

1 Like

Heya, All top 50 KPIā€™s are automatically tracked as soon as you have successfully installed the SDK.

The SDK also automatically send business events when developer products and game passes (only in-game) are bought. If you would like to manually configure your business events you can disable the automatic events in the settings script.

1 Like

Just a note - this doesnā€™t look like itā€™s working by default.

Whoever coded it was using a call to require(ā€œTableā€) - which obviously errored.

1 Like

I could not get any events that I programmed on my own to workā€¦ iā€™m going insane.

4 Likes

I couldnā€™t even startā€¦
As soon as I installed the plugin, these errors already appeared:

1 Like

To be honest, this has to be one of the worst documented SDKs, I looked at the other implementations into unity / unreal and it seems relatively well documented, however the Roblox documentation lacks so much detail its practically impossible to get it working quickly. everything is written as if it was made for a 4 year old. There is such little clarity in the docs that I have 0 clue how to push info for the benchmark page etc, please provide better documentation.

5 Likes

Is there any way to install using Wally? I tried looking at the official documentation on installing using Wally but that just game me a command that errors.

It seems like that whoever wrote the documentation to install using Wally doesnā€™t know how it even works or to install.

You are supposed to add the below code to the wally.toml:

gameanalytics-sdk = "gameanalytics/gameanalytics-sdk@2.2.3"

Not run this in the command line which just errors:

wally install gameanalytics

Apart from getting GameAnalytics in Wally I could not out any more on installing through Wally.