# Setup
## Integration steps
Use this order for a new integration:
1. Install the Bridge package for your engine.
2. Create or update `playgama-bridge-config.json` in the [config editor](https://playgama.github.io/bridge-config-editor/).
3. Wait for Bridge initialization before calling SDK APIs.
4. Read `platform.language` and apply localization.
5. Load saved progress with `storage.get(...)`.
6. Send `platform.sendMessage('game_ready')` when the first playable frame is ready.
7. Add interstitial ads at natural pauses, such as level transitions or game over.
{% tabs %}
{% tab title="Plain JS" %}
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
Add the script from CDN:
```html
...
```
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.
#### Config
Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update `playgama-bridge-config.json`. This file stores SDK settings: platform identifiers, in-game purchases, ad placements and more.
#### Initialization
Call the initialization method and wait for it to finish before using any `bridge.*` API.
```javascript
bridge.initialize()
.then(() => {
// initialization was successful, SDK can be used
})
.catch(error => {
// error, something went wrong
})
```
{% endtab %}
{% tab title="Unity" %}
#### 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
{% hint style="success" %}
Use the example project as a reference integration:
{% endhint %}
#### Config
`WebGLTemplates/Bridge/playgama-bridge-config.json` stores SDK settings: platform identifiers, in-game purchases, ad placements and more. Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update it.
#### **Initialization and Build**
{% hint style="info" %}
Enable `Decompression Fallback` in Unity build settings before building WebGL.
{% endhint %}
The Unity package initializes Bridge automatically while the game loads. No extra initialization call is required.
Select the Bridge WebGL Template before building.
{% endtab %}
{% tab title="Construct 3" %}
#### Installation
Download the latest version of `playgama_bridge.c3addon` from the [GitHub release page](https://github.com/playgama/bridge-construct/releases).
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
1. Set `Use Worker` to `No` in the project settings:
#### Config
Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update `playgama-bridge-config.json`, then import it into the `Files` folder. This file stores SDK settings: platform identifiers, in-game purchases, ad placements and more.
{% hint style="warning" %}
When updating the plugin, review and save `playgama-bridge-config.json` in the [config editor](https://playgama.github.io/bridge-config-editor/).
{% endhint %}
{% endtab %}
{% tab title="GDevelop" %}
#### Installation
**GDevelop IDE**
Go to `Project Manager` → `Create or search for new extensions` → type `Playgama Bridge` in the `Search extensions` field and install the extension.
**Release page**
Download the required version of `PlaygamaBridge.json` from the [GitHub release page](https://github.com/playgama/bridge-gdevelop/releases).
Go to `Project Manager` → `Create or search for new extensions` → `Import extension` and select the downloaded file.
#### Config
Open the `Playgama Bridge` extension in the editor.
Select the `onFirstSceneLoaded` function. Configure SDK settings there: platform identifiers, in-game purchases, ad placements and more. Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update the configuration.
#### Initialization
Initialization starts automatically. Wait until it completes before running game logic that uses Bridge, such as reading player profile or storage data.
{% endtab %}
{% tab title="Godot" %}
#### Integration
Download the latest `playgama_bridge.zip` archive, unzip it, and place the contents into `res://addons`:
* [GitHub releases page](https://github.com/playgama/bridge-godot/releases) for Godot 3
* [GitHub releases page](https://github.com/playgama/bridge-godot-4/releases) for Godot 4
Enable the plugin in the project settings:
{% hint style="warning" %}
Place Bridge first in the AutoLoad list.
{% endhint %}
#### Config
`addons/playgama_bridge/template/playgama-bridge-config.json` stores SDK settings: platform identifiers, in-game purchases, ad placements and more. Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update it.
#### 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
```
{% endtab %}
{% tab title="GameMaker" %}
#### Installation
Download the latest `.yymps` from the [GitHub release page](https://github.com/Playgama/bridge-gamemaker/releases) and import it via `Tools` → `Import Local Package` menu.
#### Config
`datafiles/playgama-bridge-config.json` stores SDK settings: platform identifiers, in-game purchases, ad placements and more. Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update it.
#### 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.
{% endtab %}
{% tab title="Defold" %}
#### Installation
Copy the `Source code.zip` link from the [GitHub release page](https://github.com/Playgama/bridge-defold/releases) and add it as a dependency in your project settings.
Then select `Project` → `Fetch Libraries`.
#### Config
Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update `playgama-bridge-config.json`. Import it into `res/web` and add the `/res` folder to `Bundle Resources`. This file stores SDK settings: platform identifiers, in-game purchases, ad placements and more.
#### 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.
{% endtab %}
{% tab title="Cocos Creator" %}
#### Installation
Download the latest `.zip` archive from the [GitHub release page](https://github.com/Playgama/bridge-cocos-creator) 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`.
#### Build Template
{% hint style="danger" %}
Use the `web-mobile` build target. Bridge provides templates for `web-mobile` and `preview` builds.
{% endhint %}
#### Config
`extensions/playgama-bridge/playgama-bridge-config.json` stores SDK settings: platform identifiers, in-game purchases, ad placements and more. Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update it.
Use the `web-mobile` build target for publishing.
{% hint style="warning" %}
`playgama-bridge-config.json` is copied automatically from the extension folder to the `web-mobile` build folder after each build.
{% endhint %}
{% endtab %}
{% tab title="Scratch" %}
#### Integration
Download `PlaygamaBridge.js` from the [GitHub release page](https://github.com/playgama/bridge-scratch/releases). In TurboWarp, click `Add Extension`, select `Custom Extension`, choose the downloaded file, and enable `Run without sandbox`.
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.
#### Config
Use the [config editor](https://playgama.github.io/bridge-config-editor/) to create or update `playgama-bridge-config.json`, then add it to your project. This file stores SDK settings: platform identifiers, in-game purchases, ad placements and more.
#### Initialization
Call the initialization method and wait for it to finish before using Bridge blocks.
{% endtab %}
{% endtabs %}
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://wiki.playgama.com/playgama/sdk/setup.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.