All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams
Documentation · Quick Start · QQ Group: 467608841 / 233840761
GameFrameX Godot is the Godot .NET project and integration sample for the GameFrameX framework. It combines reusable runtime modules, editor plugins, hotfix assemblies, resource-driven UI examples, and verification scenes.
- Modular components for lifecycle, object pooling, reference pooling, events, FSM, timers, entities, settings, and global configuration.
- Asset and startup workflows for resource packages, version checks, downloading, procedures, and hotfix assembly loading.
- Network, Web, Web Protobuf, localization, configuration-table, and channel utilities.
- Godot GUI and FairyGUI UI adapters with form lifecycle, grouping, depth, and asynchronous loading support.
- Editor plugins and runtime verification scenes for asset, configuration, protocol, UI, and project workflows.
Requirements:
- Godot .NET 4.7.1.
- .NET 8 SDK. Android builds use .NET 9 according to the project configuration.
Clone the repository, open it in the Godot .NET editor, and wait for .NET dependencies to restore. GameFrameX modules are under addons/ and core modules are enabled through project.godot.
Effective on install: GameFrameXRuntimeBootstrap is registered as an autoload. It claims ownership before the main scene loads and creates the persistent [GameFrameX] host on the first idle frame, mounting every framework component automatically in dependency order — no component nodes in scenes, zero scene changes required. GameFrameX components placed by hand in a scene are detected and self-suppressed with a [GameFrameX]-prefixed warning.
Module parameters are injected once, before first module instantiation, via GameFrameXOptions:
using GameFrameX.Runtime;
using GameFrameX.Timer.Runtime;
// Classes implementing IGameFrameXOptionsContributor are discovered silently and applied automatically — no registration code
public sealed class MyGameOptionsContributor : IGameFrameXOptionsContributor
{
public void ConfigureOptions(GameFrameXOptionsContributorContext context)
{
context.Configure(new TimerOptions { CatchCallbackExceptions = true });
}
}Components stay thin entries (pure forwarding); runtime adjustments go through the GetModule<T>() / GameApp.X module APIs.
Run one of these scenes:
Scenes/Launcher.tscn— main scene; components are injected by the auto host and the startup pipeline (version requests → manifest → download → hotfix entry) is driven byStartupRunner.Scenes/LauncherAuto.tscn— code-driven startup entry behaving like Launcher (components still injected by the auto host).Scenes/Verification/AssetSystemRuntimeVerifier.tscn— asset-system runtime check.Scenes/Verification/ProtoMessageRuntimeVerifier.tscn— Protobuf HTTP loopback check.
Registered runtime components can be retrieved through GameEntry:
using Godot;
using GameFrameX.Runtime;
public partial class GameManager : Node
{
public override void _Ready()
{
var objectPool = GameEntry.GetComponent<ObjectPoolComponent>();
var ui = GameEntry.GetComponent<GameFrameX.UI.Runtime.UIComponent>();
}
}See the README in the corresponding addons/com.gameframex.godot.* directory for module-specific configuration and APIs.
addons/contains reusable GameFrameX Godot modules and editor plugins.Scripts/contains project startup, procedure, UI flow, and verification scripts.Assets/contains hotfix assemblies, generated configuration code, UI resources, and runtime data.
GameFrameXRuntimeBootstrap (autoload) claims ownership before the main scene and creates the [GameFrameX] host on the first idle frame, mounting all components automatically in the order and dependency declared by [GameFrameXAutoComponent]. Scenes/Launcher.tscn carries only business nodes, while Scenes/LauncherAuto.tscn provides a code-driven startup entry — both share the same auto-injected runtime and the StartupRunner startup pipeline.
The project targets Godot 4.7 with .NET and declares Mobile rendering features. Project files contain a general .NET 8 target and an Android-specific .NET 9 target. Validate export behavior for each target platform in the Godot .NET editor before shipping.
- Godot .NET SDK 4.7.1.
- .NET 8 SDK; Android configuration targets .NET 9.
SharpZipLib1.4.2.- GameFrameX modules under
addons/, including Asset, AssetSystem, Config, Download, Entity, Event, FSM, Localization, Network, Procedure, Setting, Timer, UI, Web, and Web Protobuf. - Optional UI integrations provided by the FairyGUI and GDGUI modules.
- GameFrameX documentation
- GameFrameX GitHub organization
- GameFrameX Gitee organization
- Godot documentation
- Repository releases
See the repository releases and commit history for project changes.
See LICENSE for license information.