arrow-left

All pages
gitbookPowered by GitBook
1 of 13

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Step 4 - Initialization

Unreal integration

  1. Open your level blueprint.

  1. All blueprints nodes for PLAY SDK you can find in special category named “ReadyGamesNetwork”.

  1. Add two core nodes to start work with the SDK - Core /Initialize and Core /Update.

Tech Requirements

Unity integration

PLAY SDK requires the following software:

  • Unity 2020 LTS or later. Installation instructions.arrow-up-right

    • It is always recommended to use a late version of Unity for bug fixes and up-to-date compatibility.

hashtag
Prerequisites

hashtag
Setup your bundle identifier in the project setting:

  1. Open project settings Unity window: Edit->Project Settings...

  2. Select Player and open the Other Settings section

  3. For iOS tab change the Bundle Identifier

hashtag
Android

Choose Minimum API Level 23 in Project Settings->Player->Other Settings

For Android you can also change the Scripting Backend from Mono to IL2CPP. Since Unity Android Mono backend does not support arm64 which is required on . But to keep the development iterations faster, you can also keep Mono and only later jump to IL2CPP.

For Android, Target API Level should be 33 or higher for Google Play Store compliance.

hashtag
Integration Support

If you are unable to find a solution in our documentation you can reach out to us directly by:

  • Creating a GitHub issue

  • Dropping a message in our Discord dev-chat

For Android tab change the Package Name

Android Play Marketarrow-up-right
herearrow-up-right
herearrow-up-right

Step 2 - Import credentials

Unity integration

  1. Go on the developer dashboardarrow-up-right and select your project.

  1. Click on Download unity packages to download your project credentials.

  1. Import this file by using Unity Assets->Import Package->Custom Package... menu. After importing you should see the ReadyGamesNetwork folder in your Assets folder with all necessary settings:

Step 4 - Initialization

Unity integration

hashtag
Structure

PLAY SDK is divided into multiple modules. Every module has its own functionality. All modules depend on the RGNCore module. In the current version, the modules are distributed by using packages for .

hashtag

Obligatory modules/packages
  • RGNCore

  • RGNSignInEmail

  • RGNSignInGuest

hashtag
PLAY Unity Initializer

We created an initialization script to automatically setup every module. This script can manage automatically the guest signIn and the modules initialization. To use it, simply create an empty GameObject in your starting scene and attach RGNUnityInitilizer.cs to it. With this script, you don't need to manually build the RGNCore and modules.

hashtag
Access modules

To access modules you can use the "I" instance provider property:

For example:

hashtag
Modules namespaces

The modules are located in the RGN.Modules.[module_name] namespaces. Here you can find a full list of modules with the namespaces:

chevron-rightModules Listhashtag

RGN.Modules.Achievement

RGN.Modules.Currency

RGN.Modules.GameProgress

RGN.Modules.Inventory

RGN.Modules.Messaging

RGN.Modules.Store

RGN.Modules.UserProfile

RGN.Modules.VirtualItems

RGN.Modules.Wallets

RGN.Modules.SignIn

RGN.Modules.Leaderboard

Unity Package Managerarrow-up-right
var result = await [module_name].I.GetSomeResultAsync();
var purchaseResult = await StoreModule.I.BuyVirtualItemsAsync(itemIds);

Step 3 - Environments

Developers have access to two different environments:

  1. Staging: Use this environment while developing and testing. This environment will use the testing blockchain backend.

  2. Production: Use this environment for the releases, live versions available to users.

Example.

  1. John started integrating the PLAY SDK in his application by setting the Staging environment.

  2. He completed and tested feature Implementation in the Staging environment.

  3. After that, he is ready to update the version in Stores, So he set Production and created new builds for store submission. He did a smoke test and updated in Stores.

hashtag
Environment Setup

After setting up the above configuration data, you can switch Staging/Production environment from the Unity menu:

ReadyGamesNetwork->Set Staging

ReadyGamesNetwork->Set Production

After submitting to the stores, he switched back to the Staging environment to work on new features for their upcoming release.

Getting Started

hashtag
Structure

PLAY SDK (former READYgg SDK) is divided into multiple modules. Every module has its own functionality. All modules depend on the RGNCore module.

Step 1 - Import packages

Unreal Integration

hashtag
Package Dependencies Installation:

  1. Follow the link - https://github.com/readyio/rgn_unrealarrow-up-right and clone it somewhere nearby the project directory.

  2. Open the just pulled repository and copy the folder “Plugins” from it to the root of your project directory.

  3. Open your project via Unreal Engine again and accept the offer to rebuild the modules.

Unreal

Unreal Engine integration

Tech Requirements

Unreal integration

PLAY SDK requires the following software:

  • Unreal 5+

    • It is always recommended to use a late version of Unreal for bug fixes and up-to-date compatibility.

hashtag
Integration Support

If you are unable to find a solution in our documentation you can reach out to us directly by:

  • Creating a GitHub issue

  • Dropping a message in our Discord dev-chat

herearrow-up-right
herearrow-up-right

Step 2 - Configure credentials

Unreal integration

  1. Go on the and select/create your project.

  1. Open the project settings and scroll down to the Plugins category and find the “ReadyGamesNetwork”, then fill the ProjectId and ApiKey fields by values from your console project.

developer dashboardarrow-up-right

Step 3 - Environments

Unreal integration

Developers have access to two different environments:

  1. Staging: Use this environment while developing and testing. This environment will use the testing blockchain backend.

  2. Production: Use this environment for the releases, live versions available to users.

Example.

  1. John started integrating the READYgg SDK in his application by setting the Staging environment.

  2. He completed and tested feature Implementation in the Staging environment.

  3. After that, he is ready to update the version in Stores, so he set Production and created new builds for store submission. He did a smoke test and updated in Stores.

  4. After submitting to the stores, he switched back to the Staging environment to work on new features for their upcoming release.

hashtag
Environment Setup

After setting up the above configuration data, you can switch Staging/Production environment from the Unreal plugin setting menu:

ReadyGamesNetwork->Environment Target->Staging

ReadyGamesNetwork->Environment Target->Production

Unity

Unity integration

Step 1 - Import packages

hashtag
Package Dependencies

In case you use an older version of Unity you need to add the Newtonsoft Json package. You can install it by pasting following into your manifest.json file:

In the new Unity versions the Newtonsoft Json is build in to Unity. No need to install the package.

hashtag
Dependencies Installation:

  1. Git package repository link. The easiest way to add the READYgg SDK into your project is to use PLAY package distribution. You need simply put the package git repository links into manifest.json file. See instructions below.

Troubleshooting : if you have error messages in Unity saying that it cannot find the git repository, make sure you have Git installed on your machine. Unity Hub needs it to import packages from Github.

hashtag
Steps:

  1. Open [project_dir]/Packages/manifest.json file in your favorite text editor

"com.unity.nuget.newtonsoft-json": "3.2.1",
Paste following lines:
circle-info

If you don't need some of the functionality, you can try to remove some modules.

Partially removing some of the modules while keeping the others has not been thoroughly tested yet by the RGN team, if you encounter any issues please contact us.arrow-up-right

The manifest.json file after all changes should look similar to this:

Afterwards switch to Unity and wait until the packages import finishes.

hashtag
Steps:

  1. Open Unity project

  2. Open Package Manager Window by clicking Unity menu Window->Package Manager

  3. Click "+" button on left upper corner

  4. Select "Add package from git URL..."

  5. Paste the package links one by one:

"io.getready.rgn.achievement": "https://github.com/readyio/RGNAchievement.git#0.12.0",
"io.getready.rgn.analytics
"
:
"
https://github.com/readyio/RGNAnalytics.git#0.12.0
"
,
"io.getready.rgn.core": "https://github.com/readyio/RGNCore.git#0.12.0",
"io.getready.rgn.currency": "https://github.com/readyio/RGNCurrency.git#0.12.0",
"io.getready.rgn.gamepass": "https://github.com/readyio/RGNGamePass.git#0.12.0",
"io.getready.rgn.gameprogress": "https://github.com/readyio/RGNGameProgress.git#0.12.0",
"io.getready.rgn.inventory": "https://github.com/readyio/RGNInventory.git#0.12.0",
"io.getready.rgn.leaderboard": "https://github.com/readyio/RGNLeaderboard.git#0.12.0",
"io.getready.rgn.marketplace": "https://github.com/readyio/RGNMarketplace.git#0.12.0",
"io.getready.rgn.matchmaking": "https://github.com/readyio/RGNMatchmaking.git#0.12.0",
"io.getready.rgn.signin.email": "https://github.com/readyio/RGNSignInEmail.git#0.12.0",
"io.getready.rgn.signin.guest": "https://github.com/readyio/RGNSignInGuest.git#0.12.0",
"io.getready.rgn.store": "https://github.com/readyio/RGNStore.git#0.12.0",
"io.getready.rgn.userprofile": "https://github.com/readyio/RGNUserProfile.git#0.12.0",
"io.getready.rgn.virtualitems": "https://github.com/readyio/RGNVirtualItems.git#0.12.0",
"io.getready.rgn.wallets": "https://github.com/readyio/RGNWallets.git#0.12.0",
https://github.com/readyio/RGNAchievement.git#0.12.0
https://github.com/readyio/RGNAnalytics.git#0.12.0
https://github.com/readyio/RGNCore.git#0.12.0
https://github.com/readyio/RGNCurrency.git#0.12.0
https://github.com/readyio/RGNGamePass.git#0.12.0
https://github.com/readyio/RGNGameProgress.git#0.12.0
https://github.com/readyio/RGNInventory.git#0.12.0
https://github.com/readyio/RGNLeaderboard.git#0.12.0
https://github.com/readyio/RGNMarketplace.git#0.12.0
https://github.com/readyio/RGNMatchmaking.git#0.12.0
https://github.com/readyio/RGNSignInEmail.git#0.12.0
https://github.com/readyio/RGNSignInGuest.git#0.12.0
https://github.com/readyio/RGNStore.git#0.12.0
https://github.com/readyio/RGNUserProfile.git#0.12.0
https://github.com/readyio/RGNVirtualItems.git#0.12.0
https://github.com/readyio/RGNWallets.git#0.12.0