Skip to content

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.

  • The target is Windows x86_64.
  • The project uses exactly Godot 4.7.1, 4.4.1, or 3.6.2.
  • A positive appId has been issued for the game.
  • All required files come from one Godot SDK release and one exact-version variant in Release Notes.
FileWhen to download it
igp-godot-sdk-core.zipAlways required
igp-godot-sdk-compliance.zipRequired for real-name verification and anti-addiction
igp-godot-sdk-game-kit.zipRequired for profiles, players, leaderboards, or sharing
igp-godot-sdk-multiplayer.zipRequired for native Godot multiplayer, Hosted Session, or the Arena TCP/UDP data plane
igp-godot-sdk-test.zipOptional complete test project; this is not an addon
igp-godot-multiplayer-sample.zipOptional complete multiplayer project and local E2E; this is not an addon

Do not mix ZIP files from different SDK versions or Godot variants.

  1. Open the project in the exact Godot version named by the downloaded variant.
  2. In the AssetLib / Asset Store panel, choose local Import and select igp-godot-sdk-core.zip.
  3. Keep the target at the project root, res://. The preview must show addons/igp_sdk directly, not addons/addons/igp_sdk.
  4. Open Project Settings > Plugins and enable IGP SDK.
  5. Import Compliance, GameKit, and Multiplayer the same way when needed. Optional packages do not require another plugin toggle.
  6. Stop and restart the running game so the IGP Autoload detects newly installed optional modules.

The final paths are:

res://addons/igp_sdk
res://addons/igp_sdk_compliance # optional
res://addons/igp_sdk_game_kit # optional
res://addons/igp_sdk_multiplayer # optional

For manual installation, extract each ZIP and merge its addons directory into the project root. Do not copy an optional package inside addons/igp_sdk.

After enabling Core:

  1. Open Project Settings > Igp > General.
  2. Set igp/general/app_id to the positive integer issued by IGP.
  3. Keep igp/general/environment at prod for production unless the project explicitly uses preview or development infrastructure.
  4. 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.

  • IGP SDK is enabled under Project Settings > Plugins.
  • The project starts without GDExtension or GDNative load errors.
  • /root/IGP exists and IGP.achievements, IGP.user, and IGP.authorization are available.
  • IGP.compliance is not null after installing Compliance.
  • Profile, Players, Leaderboard, and Share modules are not null after 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.