Skip to main content

Unity Plugin

download sdk for unity

Installation​

1 - Download the unity package

2 - Open it in your Unity WebGL project and add it to the project (tested in Unity 2022.3.21f1)

Usage​

The main interface with the web Arkadium SDK is the ArkadiumSDK singleton in the plugin. Be sure to call the initialize method before doing any meaningful calls.

_sdk = ArkadiumSDK.Instance;
_sdk.InitializeDev("your-games-game-id-goes-here", OnInitializeCb);

API​

void SetLogLevel(LogLevel logLevel)​

use this function to set the logging level you need. These are the supported values:

  • LogLevel.NONE - no console.logs will be printed
  • LogLevel.UNITY_LOGS - Unity's c# layer will print logs
  • LogLevel.JSLIB_LOGS - browser's JS bridge layer will print logs
  • LogLevel.ALL_LOGS - both C# and JS will print logs
_sdk.SetLogLevel(LogLevel.ALL_LOGS);

void InitializeDev(string eagleGameSlug, Action<bool> cb)​

Initializing the SDK using this function will target the DEV environment. Make sure to replace with Initialize before generating deliverables for a prod game.

_sdk.InitializeDev("your-games-game-id-goes-here", OnInitializeCb);

void Initialize(string environment, string eagleGameSlug, Action<bool> cb)​

Initializing the SDK using this function will target the PROD environment. This is the method to use when preparing deliverables for release.

_sdk.Initialize("your-games-game-id-goes here", OnInitializeCb);

Ads​

The following methods expose ways to monetize your game via ads, both video (interstitials and reward ads) which appear over your game, and static banners (banner ads), which populate elements around the game canvas.

void ShowInterstitialAd(int duration, Action<bool> cb)​

This method requests an interstitial video ad pod to be displayed with the desired duration in seconds. The action will return you back whether the ad was watched.

_sdk.Ads.ShowInterstitialAd(10, ShowInterstitialAdCb);

void ShowRewardAd(int duration, Action<int> cb)​

This method requests a reward video ad pod to be displayed with the desired duration in seconds. The action will return you back whether the ad was watched.

_sdk.Ads.ShowRewardAd(30, ShowRewardAdCb);

void ShowBannerAd(string elementId, params string[] bannerSizes)​

This method populates the DOM element with id elementId with the better suited banner size out of the passed array. This is a fire and forget method, it receives no action.

These are the supported banner sizes:

  • AD_300x250
  • AD_250x250
  • AD_336x280
  • AD_300x600
  • AD_728x90
  • AD_970x90
  • AD_970x250
  • AD_320x50
  • AD_320x100
  • AD_468x60
  • AD_160x600
_sdk.Ads.ShowBannerAd("banner_container_id_goes_here", ArkadiumAds.AD_320x50);

Analytics​

The following set of methods deal with preparing and populating analytics providers with data about the game. Using analytics providers is key to understand how the game is performing.

void ConfigureProvider(AnalyticsProvider provider, string appId)​

For a game to be release on Arkadium platforms, you must have received a set of ids to use for analytics. Use them here. The console provider's sole purpose is to help debug analytics in the console. It doesn't send data.

_sdk.Analytics.ConfigureProvider(AnalyticsProvider.CONSOLE, "ANYTHING-GOES-IN-THIS-ONE");
_sdk.Analytics.ConfigureProvider(AnalyticsProvider.APP_INSIGHTS, "08a82ae3-afc0-4532-b61e-c76be7277faa");

void SendEvent(string eventCategory, string eventCategory, Dictionary<string, string> dimensions_)​

This method sends an event of given eventCategory with eventCategory and a dictionary of additional dimensions you may want to send along with it.

var dims = new Dictionary<string, string> { { "dim1", "set-by-event" } };
_sdk.Analytics.SendEvent("category", "action", dims);

void SendPageView(string pageName, Dictionary<string, string> dimensions_)​

This method sends a pageView of given pageName and a dictionary of additional dimensions you may want to send along with it.

var dims = new Dictionary<string, string> { { "dim2", "set-by-page-view" } };
_sdk.Analytics.SendPageView("pageName", dims);

void SetDimensions(Dictionary<string, string> dimensions_)​

This is an optional method to allow you to supply dimensions to the analytics provider before sending events or page views. If a dictionary exists on both, the event/page view value takes precedence.

var dims = new Dictionary<string, string> {
    {"dim1", "set-by-dims"},
    {"dim2", "set-by-dims"},
    {"other-one", "42" },
};
_sdk.Analytics.SetDimensions(dims);

Auth​

This set of methods provides ways for your game to react to your player being logged in and using its profile info to display things such as the user name of its avatar in-game.

void IsUserAuthorized(Action<bool> cb)​

This method returns back to the given action whether the user is signed in.

_sdk.Auth.IsUserAuthorized(IsUserAuthorizedCb);

void SubscribeToAuthStatus(Action<bool> cb)​

Use this method to get notified when the logged in status of the user changes.

void UnsubscribeToAuthStatus(Action<bool> cb)​

Use this method to stop being notified about when the logged in status of the user changes.

void GetUserProfile(Action<UserProfile> cb)​

If the user is logged in, you can obtain a set of user-related data using this method

public class UserProfile {
    public string uid;
    public string username;
    public UserProfileImage avatar;
    public UserProfileImage avatarFrame;
    public string avatarBackground;
    public bool isUserSubscriber;
}

// where UserProfile image is the following

public class UserProfileImage {
    public string png;
    public string webp;
}
_sdk.Auth.GetUserProfile(GetUserProfileCb);

void OpenAuthForm(Action cb)​

Use this method to prompt the platform to display the login form.

_sdk.Auth.OpenAuthForm(OpenAuthFormCb);

Host​

This set of methods provide ways for the game to act on the hosting platform site.

void GetQueryParameter(string param, Action<string> cb)​

This method allows the game to read a query parameter passed on from the topmost URL used to access the game. It will return empty string if that parameter is not set.

_sdk.Host.GetQueryParameter("param", GetQueryParameterCb);

void GetDetails(Action<Details> cb)​

This method allows obtaining several details from the platform side:

This is the shape of the object you should expect:

public class Details {
    public string GameKey;
    public string GameVersion;
    public string NestVersion;
    public string SdkVersion;
}
_sdk.Host.GetDetails(GetDetailsCb);

void OpenPurchaseForm(Action<bool> cb)​

This method allows the game to display a platform form where the player will be able to purchase currency (gems).

Check Gems & Currency for more details.

_sdk.Host.OpenPurchaseForm(OpenPurchaseFormCb);

Leaderboards​

All the following leaderboards methods allow you to interact with game leaderboards, including checking support, retrieving scores, and posting new scores.

void IsSupported(Action<bool> cb)​

Check if leaderboard service is supported.

_sdk.Leaderboard.IsSupported((bool success) =>
        {
	        // use success here
	});

void PostScore(int score, Action<bool> cb);​

Post a new score.

_sdk.Leaderboard.PostScore(10, (bool success) =>
	{
		// use success here
	});

void GetUserScore(Action<int> cb, string type = "")​

Get user's score.

_sdk.Leaderboard.GetUserScore((int score) =>
	{
		// use score here
	});

Optionally, a leaderboard type ("day","week","month","all") can be passed to the API, to fetch the corresponding user's score for that leaderboard:

_sdk.Leaderboard.GetUserScore((int score) =>
	{
		// use score here
	}, "day");

void GetTopScores(Action<LeaderboardEntry[]> cb, string type = "", int limit = 100)​

Fetch top scores.

_sdk.Leaderboard.GetTopScores((LeaderboardEntry[] entries) =>
	{
		// example iteration of leaderboard entries
		foreach (var entry in entries)
		{
                        // use entry here
		}
	});

Optionally, a leaderboard type ("day","week","month","all") can be passed to the API, to fetch the corresponding user's score for that leaderboard.

Optionally, a limit can also be passed to retrieve that amount of leaderboard entries (the default is 100).

The following example retrieves the top 20 entries from the weekly leaderboard:

_sdk.Leaderboard.GetTopScores((LeaderboardEntry[] entries) =>
	{
		// example iteration of leaderboard entries
		foreach (var entry in entries)
		{
                        // use entry here
		}
	}, "week", 20);

The returned type LeaderboardEntry has the following structure:

LeaderboardEntry
{
        int rank
	int score
	string username
	string avatar
}

Lifecycle​

Lifecycle methods are a way for the platform to be able to measure and react to key game moments. All these methods are fire and forget.

void OnTestReady()​

This is a mandatory call. You're meant to call it as soon as you have a game frame ready, as it hides the loading screen from the platform.

void OnInteract()​

Call this at first player interaction with the game.

void OnGameStart()​

Call this when the game starts.

void OnGameEnd()​

Call this when the game ends.

void OnPauseReady()​

Call this when your game is ready to be paused.

void OnGamePause()​

Call this when your game started the pause state.

void OnGameResume()​

Call this when your game resumed from a paused state.

void OnChangeScore(int score)​

Call this method before finishing the game, providing the platform with the score the player achieved. This updates the platform leaderboard of the game.

void RegisterEventCallback(ArkadiumLifecycleEvent eventId, Action cb)​

In some flows, the Arena might need to control the game flow by pausing and resuming the game. The game will need to implement it's own pause/resume logic and register it as an event callback. There are 2 events to which the game will need to register callbacks: GAME_PAUSE and GAME_RESUME. Below there are examples on how to register these callbacks.

// PauseGame
_sdk.Lifecycle.RegisterEventCallback(ArkadiumLifecycleEvent.PauseGame, () =>
{
	// logic to PAUSE game goes here
});

// ResumeGame
_sdk.Lifecycle.RegisterEventCallback(ArkadiumLifecycleEvent.ResumeGame, () =>
{
	// logic to RESUME game goes here
});

Persistence​

All the following persistence methods expose ways to read, write or delete data.

void GetLocalStorageItem(string key, Action<string> cb)​

Use this method to get the value stored for the given key in local storage. Empty string will the returned if the key isn't found.

_sdk.Persistence.GetLocalStorageItem("test_key", (string value) =>
	{
        // use value
	});

void SetLocalStorageItem(string key, string value, Action<bool> cb)​

Use this method to set the given key of local storage to the given value.

var value = "{ \"universe\": 42 }";
_sdk.Persistence.SetLocalStorageItem("test_key", value, (bool success) =>
	{
        // use set success
	});

void RemoveLocalStorageItem(string key, Action<bool> cb)​

Use this method to remove the given key from local storage.

_sdk.Persistence.RemoveLocalStorageItem("test_key", (bool success) =>
	{
        // use remove success
	});

void GetCookie(string key, Action<string> cb)​

Use this method to read a cookie value.

_sdk.Persistence.GetCookie("dumpling", (string value) =>
	{
        // use value
	});

void GetRemoteStorageItem(string key, Action<string> cb)​

Use this method to get the value stored for the given key in remote storage. Empty string will the returned if the key isn't found.

_sdk.Persistence.GetRemoteStorageItem("test_key", (string value) =>
	{
        // use value
	});

void SetRemoteStorageItem(string key, string value, Action<bool> cb)​

Use this method to set the given key of remote storage to the given value.

var value = "{ \"universe\": 42 }";
_sdk.Persistence.SetRemoteStorageItem("test_key", value, (bool success) =>
	{
        // use set success
	});

void RemoveRemoteStorageItem(string key, Action<bool> cb)​

Use this method to remove the given key from remote storage.

_sdk.Persistence.RemoveRemoteStorageItem("test_key", (bool success) =>
	{
        // use remove success
	});

Wallet​

All the following wallet methods expose ways to get and consume gems.

void GetGems(Action<int> cb)​

Use this method to get the amount of gems from the user's wallet.

_sdk.Wallet.GetGems((int gems) =>
	{
        // use gems
	});

void ConsumeGems(int value, Action<bool> cb)​

Use this method to consume an amount of gems from the user's wallet.

_sdk.Wallet.ConsumeGems(1, (bool success) =>
	{
        // check consumption success 
	});