Godot Installation
This page explains how to add IGP Godot SDK to an existing Godot project. A regular integration only needs the SDK ZIP files and the platform-issued appId; it does not require C#/.NET or a game executable path.
Before installation
Section titled “Before installation”- The target is Windows x86_64.
- The project uses exactly Godot 4.7.1, 4.4.1, or 3.6.2.
- A positive
appIdhas been issued for the game. - All required files come from one Godot SDK release and one exact-version variant in Release Notes.
| File | When to download it |
|---|---|
igp-godot-sdk-core.zip | Always required |
igp-godot-sdk-compliance.zip | Required for real-name verification and anti-addiction |
igp-godot-sdk-game-kit.zip | Required for profiles, players, leaderboards, or sharing |
igp-godot-sdk-multiplayer.zip | Required for native Godot multiplayer, Hosted Session, or the Arena TCP/UDP data plane |
igp-godot-sdk-test.zip | Optional complete test project; this is not an addon |
igp-godot-multiplayer-sample.zip | Optional complete multiplayer project and local E2E; this is not an addon |
Do not mix ZIP files from different SDK versions or Godot variants.
Import in the editor
Section titled “Import in the editor”- Open the project in the exact Godot version named by the downloaded variant.
- In the AssetLib / Asset Store panel, choose local Import and select
igp-godot-sdk-core.zip. - Keep the target at the project root,
res://. The preview must showaddons/igp_sdkdirectly, notaddons/addons/igp_sdk. - Open
Project Settings > Pluginsand enable IGP SDK. - Import Compliance, GameKit, and Multiplayer the same way when needed. Optional packages do not require another plugin toggle.
- Stop and restart the running game so the
IGPAutoload detects newly installed optional modules.
The final paths are:
res://addons/igp_sdkres://addons/igp_sdk_compliance # optionalres://addons/igp_sdk_game_kit # optionalres://addons/igp_sdk_multiplayer # optionalFor manual installation, extract each ZIP and merge its addons directory into the project root. Do not copy an optional package inside addons/igp_sdk.
Configure appId
Section titled “Configure appId”After enabling Core:
- Open
Project Settings > Igp > General. - Set
igp/general/app_idto the positive integer issued by IGP. - Keep
igp/general/environmentatprodfor production unless the project explicitly uses preview or development infrastructure. - Do not add a runtime directory, executable path, or pipe setting; a regular integration does not use them.
The plugin registers the /root/IGP Autoload. Do not create a second Autoload with the same name.
Installation checks
Section titled “Installation checks”- IGP SDK is enabled under
Project Settings > Plugins. - The project starts without GDExtension or GDNative load errors.
/root/IGPexists andIGP.achievements,IGP.user, andIGP.authorizationare available.IGP.complianceis notnullafter installing Compliance.- Profile, Players, Leaderboard, and Share modules are not
nullafter installing GameKit. IGP.create_multiplayer_peer()returns the native peer for the current Godot major version after installing Multiplayer.
Continue with Godot Quick Start, or open the Godot test project to inspect the complete UI first.