Migration Guide

This guide helps you migrate from GridBuilding 5.0.3 to the current GridPlacement 6.0 internal development line.

⚠️ Major Architectural Changes

6.0 is no longer the GDScript and GECS line described by older public drafts. The current repository and supported internal development path use C# plus Friflo ECS with a clean separation between Core logic and Godot adapter code.

This is not a minor patch. You should plan for setup, project structure, and integration changes.

What’s Different in 6.0

Aspectv5.0 (Base)v6.0 (ECS)
Implementation languageGDScriptC#
Runtime architectureNode-first composition + injector wiringFriflo ECS systems with Core plus Godot boundary
Primary public shapeScene nodes, state objects, and runtime rulesService-oriented setup plus ECS-backed workflow execution
Godot integrationaddons/grid_building/cs/Godot/addons/GridPlacement/
Support statusProduction maintenance lineInternal development with a green ECS build lane and blocked workflow suite repair

Migration Approach

  1. Start with setup — Install the .NET and Godot prerequisites documented in the 6.0 setup guide.
  2. Adopt the new boundary — Treat Core, ECS, and Godot as distinct layers instead of continuing 5.0 node-first wiring.
  3. Validate against the release gate — Use the documented ECS build command and check the current workflow coverage status before trusting a migration slice.

📖 Getting Started

🚀 New to v6.0? Start with the comprehensive 6.0 Guides section.

🔧 Need specific technical details?

Why the Big Change?

The 6.0 internal development direction is solving long-standing issues from the 5.x line:

  • Stronger typing — C# plus .NET 8 give the runtime clearer public contracts and tooling.
  • Cleaner boundaries — Core rules can be verified outside the Godot adapter layer.
  • Focused workflow audit — Placement and manipulation flows now have a dedicated workflow suite, but that suite is currently failing on the audited branch.
  • Explicit support story — The public release-readiness guide calls out what is ready for internal development use versus what still blocks GA.

Practical Migration Notes

  • keep 5.0 and 6.0 projects separate during migration; do not mix addons/grid_building assets into the 6.0 C# adapter tree
  • plan for new setup work around .NET 8, Godot C# support, and solution builds
  • use the 6.0 API reference and guides as the source of truth instead of older GECS-era pages or notes
  • do not assume the workflow coverage suite is green until it passes on your branch
  • treat the historical broken legacy core test lane as a known repository issue, not as a migration success signal

Validated By

  • dotnet build cs/Core/ECS/GridPlacement.ECS.csproj --nologo -v minimal confirms the currently green public build lane.
  • cs/Core/Tests/WorkflowCoverage/PlacementManipulationEndToEndTests.cs defines the workflow behavior that migration guidance depends on, but the suite currently needs repair on the audited branch.