Setup

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Installation

Install the Bridge package for your engine:

JS Core contains the shared SDK logic. Engine packages for Unity, Godot, Construct and other engines are wrappers around JS Core. Use JS Core directly in web engines such as PlayCanvas, Phaser, LayaAir and similar frameworks.

Integration

CDN is the recommended option. It always serves the current stable build, and only the adapter of the platform the game actually runs on is downloaded. Choose npm when the build has to be self-contained — offline builds, a strict CSP, or a bundler that manages every dependency.

CDN (recommended)

Add the script from CDN:

<html>
    <head>
        <script src="https://bridge.playgama.com/v2/stable/playgama-bridge.js"></script>
    </head>
    <body>...</body>
</html>

npm

npm i @playgama/bridge

import bridge from '@playgama/bridge'

The npm build inlines every platform adapter into a single file, so nothing is fetched at runtime. It also assigns window.bridge, so code written against the global keeps working.

For TypeScript projects:

// constant values without pulling in the SDK runtime — works with the CDN build too
import { PLATFORM_MESSAGE, BANNER_STATE } from '@playgama/bridge/constants'

// typings for the global `bridge` when the SDK is loaded with a <script> tag
import type {} from '@playgama/bridge/global'

With both options, place playgama-bridge-config.json next to your index.html — Bridge loads it from ./playgama-bridge-config.json.

When the game launches on a supported platform, Bridge automatically loads the required platform scripts. In unsupported environments, Bridge uses a mock platform and returns safe defaults (false, reject, etc.) instead of throwing.

Initialization

Call the initialization method and wait for it to finish before using any bridge.* API.

bridge.initialize()
    .then(() => {
        // initialization was successful, SDK can be used
    })
    .catch(error => {
        // error, something went wrong
    })

Installation

Open Window → Package Management → Package Manager
Click the plus button and select Install package from git URL
Enter https://github.com/playgama/bridge-unity.git
Open Playgama → Bridge Setup and click Add in the Add Bridge WebGL Template section

Use the example project as a reference integration:

https://github.com/playgama/bridge-unity-examples

Initialization and Build

The Unity package initializes Bridge automatically while the game loads. No extra initialization call is required.

Select the Bridge WebGL Template before building.

Installation

Download the latest version of playgama_bridge.c3addon from the GitHub release page.

Go to Menu → View → Addon Manager and click Install new addon.... Select the downloaded file and click Install in the popup window.

Open your project, right-click on the Object types folder, and select Add new object type. Choose Playgama Bridge and click Insert.

Setup

Set Use Worker to No in the project settings (Menu → Project → Properties).

Installation

Release page

Download the required version of PlaygamaBridge.json from the GitHub release page.

Go to Project Manager → Create or search for new extensions → Import extension and select the downloaded file.

Initialization

Initialization starts automatically. Wait until it completes before running game logic that uses Bridge, such as reading player profile or storage data. Use the Is Initialized condition to gate that logic.

Integration

Download the latest playgama_bridge.zip archive, unzip it, and place the contents into res://addons:

GitHub releases page for Godot 3
GitHub releases page for Godot 4

Enable the plugin in the project settings:

Place Bridge first in the AutoLoad list.

Initialization

The Godot plugin initializes Bridge automatically while the game loads. No extra initialization call is required.

Build

Select the Bridge HTML template in export settings under Custom HTML Shell:

res://addons/playgama_bridge/template/index.html

Installation

Download the latest .yymps from the GitHub release page and import it via Tools → Import Local Package menu.

Initialization and Build

The GameMaker package initializes Bridge automatically while the game loads. No extra initialization call is required.

Select the Bridge index template before building.

Installation

Copy the Source code.zip link from the GitHub release page and add it as a dependency in your project settings.

Then select Project → Fetch Libraries.

Initialization and Build

The Defold package initializes Bridge automatically while the game loads. No extra initialization call is required.

Select the Bridge index template before building.

Installation

npm is the recommended option. The SDK is bundled with your scripts, TypeScript typings come with the package, and no editor extension has to be kept in sync with the project.

npm (recommended)

Install the package in the project root — the folder that contains assets/:

npm i @playgama/bridge

Import the SDK and initialize it before using any API:

import bridge from '@playgama/bridge'

bridge.engine = 'cocos'

bridge.initialize()
    .then(() => {
        // initialization was successful, SDK can be used
    })

Put playgama-bridge-config.json into build-templates/web-mobile/ — Cocos Creator copies that folder into the build output, so the file ends up next to index.html, where Bridge looks for it.

Editor extension

Download the latest .zip archive from the GitHub release page and import it into your project. Import all files except the optional Examples folder. The extension installs web-mobile and preview templates automatically; you can also run manual installation from Extensions → Playgama Bridge → Install.

The templates load the SDK from CDN, set bridge.engine, and call bridge.initialize() before the game starts, so no initialization call is needed in your code. Do not combine this option with the npm package — the game would load two copies of the SDK.

Build Template

Use the web-mobile build target. Bridge provides templates for web-mobile and preview builds.

Integration

Download PlaygamaBridge.js from the GitHub release page. In TurboWarp, click Add Extension, select Custom Extension, choose the downloaded file, and enable Run without sandbox.

Initialization

Call the initialization method and wait for it to finish before using Bridge blocks.

Required steps

Installation is only the first part of the integration. Every game must also implement the required steps. See the full list with exact methods in API → Required steps.

PreviousGetting started

NextConfig

Last updated 9 days ago