Skip to content

v0.3.0 - Compatibility + Community Fixes

Latest

Choose a tag to compare

@zachhooper zachhooper released this 20 Aug 03:36
· 2 commits to main since this release
6aa211c

What's Changed



Warning

Breaking change: GDK* classes are now Xbox*. Every script-visible type was renamed from the GDK prefix to the Xbox prefix — GDKUserXboxUser, GDKResultXboxResult, GDKAchievementXboxAchievement, and so on. The C# facade moved with them: namespace GodotGdkGodotXbox, static class GdkXbox. No deprecated GDK* aliases are provided, so type references must be updated.

Why: to let this addon enable XBOX Series X|S console support inside compatible Godot engine forks. Those forks provide the XBOX Series X|S console platform layer, exports, and expose their own types, and the GDK* prefix collided with names they already use. Moving to the Xbox* prefix keeps this addon's types distinct so it can be dropped into such a fork and light up console scenarios there. Godot itself is unchanged — the engine's own console support is not something this repo provides.

One binary covers both. The same addon build runs on PC and on console — there is no separate console compilation, preset, or #define. godot_gdk.gdextension declares only the windows.*.x86_64 libraries, and those are what a console-capable fork loads too.

The singleton is still called GDK. Calls like GDK.initialize() and GDK.users.add_default_user_async() keep working unchanged — only the type names moved. The addons/godot_gdk folder, the gdk/runtime/* Project Settings, and the godot_gdk.gdextension entry point are all unchanged as well.

# before
var r: GDKResult = GDK.initialize()
var u: GDKUser = r.data

# after
var r: XboxResult = GDK.initialize()
var u: XboxUser = r.data

One consequence worth calling out: the ClassDB class name (Xbox) and the singleton name (GDK) are now different strings. If your code class-checks the singleton, compare against "Xbox"is_class("GDK") no longer matches.

See Migrating to v0.3.0 for the full old → new table, or run the codemod:

.\tools\migrate_gdk_to_xbox.ps1 -Path <your-project> -WhatIf