C# Project Setup

Use this guide to set up the current 6.0 internal development path for GridPlacement.

This page intentionally replaces older public instructions that described 6.0 as a GDScript and GECS line. The supported repository path today is:

  • C# source in GridPlacement/cs/ and its subdirectories
  • Friflo ECS for ECS components and systems
  • Godot C# integration in GridPlacement/cs/Godot/ and its subdirectories

Prerequisites

  • Godot 4.x with C# support enabled
  • .NET 8 SDK
  • Git for cloning the repository
  • a Godot project or sandbox where you can reference the 6.0 runtime and adapter code

Repository layout to know first

The main 6.0 code areas are:

  • cs/Core/ for engine-agnostic domain code
  • cs/Core/ECS/ for the Friflo ECS workflow implementation
  • cs/Godot/ for Godot adapter code, addon code, and Godot-facing systems

If you only remember one rule, remember this: do not treat 6.0 like the old addons/grid_building maintenance plugin.

1. Clone and restore

1
2
3
git clone https://github.com/ChrisTutorials/GridPlacement.git
cd GridPlacement
dotnet restore GridPlacement.sln

2. Build the supported 6.0 runtime lane

1
dotnet build cs/Core/ECS/GridPlacement.ECS.csproj --nologo -v minimal

This is the cleanest currently supported build lane for the ECS runtime.

3. Run the workflow coverage audit lane

1
dotnet test cs/Core/Tests/WorkflowCoverage/GridPlacement.WorkflowCoverage.Tests.csproj --nologo -v minimal

This suite is the intended public proof lane for the internal development architecture.

On the audited branch it is currently failing due to repository drift, so treat it as a blocker check rather than a green success signal.

4. Open the Godot adapter layer only after the ECS build lane is green

The Godot-facing 6.0 code lives under cs/Godot/. Keep in mind:

  • 6.0 Godot integration is adapter code, not the center of the domain model
  • the canonical addon home is cs/Godot/addons/GridPlacement/
  • legacy grid_building assets from 5.0 should not be mixed into this path

What not to do

  • do not follow older 6.0 pages that mention GridPlacementCS
  • do not look for a grid_building_ecs addon path as if it were the supported public install target
  • do not use the broken historical core test lane as your success signal for setup

Current support posture

6.0 is internal development, not GA.

That means:

  • the split ECS runtime builds cleanly
  • the focused workflow coverage suite is still under repair on the audited branch
  • the broader legacy test surface still needs cleanup before a production-ready claim is honest

Use the release-readiness guide before you present 6.0 as production-stable inside your own project docs.

Validated By

  • dotnet build cs/Core/ECS/GridPlacement.ECS.csproj --nologo -v minimal
  • the current release-readiness guidance for the 6.0 internal development line