GridBuilding 5.1 vs GridPlacement 6.0 — Version Lifecycle
This document defines how we treat GridBuilding 5.1 (GDScript) and GridPlacement 6.0 (C#‑first) across time:
- Which versions are current / supported.
- When we are allowed to call something legacy or deprecated.
- How we talk about GDScript vs C# support.
It is intentionally internal guidance for maintainers and docs/roadmap authors.
1. Version Matrix (High‑Level)
| Track | Tech | Status now | Future status |
|---|---|---|---|
| GridBuilding 5.1 | GDScript | Current stable for GDScript | Becomes legacy/deprecated after 6.0 C# GA and stabilization |
| GridPlacement 6.0 | C#‑first | In active development (next‑gen) | Becomes primary supported line |
| GridPlacement 6.0 | GDScript | TBD / not guaranteed | May get a GDScript adapter if there is demand |
Key points:
- 5.1 is not deprecated today.
- 6.0 is C#‑first. GDScript in 6.0 is optional and depends on demand.
- 5.1 only becomes “legacy/deprecated” after we ship a stable 6.0 C# release and have confidence in migration paths.
2. GridBuilding 5.1 (GDScript) Policy
Status now:
- Current stable release for GDScript users.
- Recommended for teams who:
- Are already invested in the 5.1 ecosystem.
- Need a GDScript‑native plugin today.
What we do for 5.1 until 6.0 C# GA:
- Ship bugfixes and critical compatibility fixes.
- Avoid large architectural refactors; 5.1 is mostly feature‑frozen.
- Keep docs and demo projects in a healthy, runnable state:
- Demo scenes open and run without errors.
- Test suites compile and run where they previously did.
When 5.1 becomes “legacy” / “deprecated”:
- Only after:
- 6.0 C# has released and is stable (core tests + docs + migration story are in place).
- At that point we can:
- Tag 5.1 as legacy in docs.
- Move code into a clearly named legacy addon or folder.
- State that 5.1 will only receive critical bugfixes, not new features.
Wording guidelines (5.1):
- Allowed now:
- “GridBuilding 5.1 is our current GDScript‑based release.”
- “5.1 will eventually become a legacy addon once 6.0 C# is stable.”
- Not allowed yet:
- “5.1 is deprecated.”
- “Users should migrate off 5.1 immediately.”
3. GridPlacement 6.0 (C#‑First) Policy
Status now:
- Next‑generation, C#‑first line.
- Under active development; APIs and structure can change.
Goals for 6.0:
- Become the primary supported line once stable.
- Provide a clean C# core with Godot adapters.
- Offer clear migration docs from GridBuilding 5.1 to GridPlacement 6.0.
What “C#‑first” means:
- Canonical runtime logic, services, and tests are C#.
- GDScript interacts mainly through adapters and thin Godot wrappers, if we choose to ship them.
- We prioritize C# API and test stability before promising GDScript parity.
Wording guidelines (6.0):
- “GridPlacement 6.0 is our next‑generation C#‑first line.”
- “6.0 is in active development and not yet a drop‑in replacement for 5.1.”
- Once stable: “6.0 is the recommended path for new projects and long‑term support.”
4. GDScript in 6.0 — Demand‑Driven
We explicitly do not promise a full GDScript port of 6.0.
- GDScript 6.0 should be framed as “TBD / demand‑driven”.
- Demand gate (explicit): we will only treat a 6.0 GDScript port/adapter as a real roadmap commitment if we receive 10+ user requests (from unique users).
- If we do not hit that demand threshold, we will push the user base toward 6.0 C# for Godot projects (one primary language is easier to maintain and higher leverage).
- Possible shapes if demand is high:
- Thin GDScript wrappers around C# services.
- A minimal compatibility layer for 5.1‑style scripts.
- If demand is low, it is acceptable to:
- Keep 5.1 as the final GDScript‑native line.
- Encourage migration to 6.0 C# when teams adopt C#.
Wording guidelines:
- “GDScript support in 6.0 is not guaranteed and will depend on community demand.”
- “Today, 5.1 remains the recommended GDScript path; 6.0 is designed C#‑first.”
5. How To Talk About This in Issues, PRs, and Docs
Use these patterns when writing tickets, PR descriptions, and docs.
5.1‑focused work
- Prefer phrasing like:
- “Prepare GridBuilding 5.1 for eventual legacy status once 6.0 C# is stable; do not mark it deprecated yet.”
- “This PR cleans up tests / docs / demo scenes for the 5.1 release line.”
- For labels, prefer:
track:5.1-legacy-prep,area:gridbuilding-5.1, etc.- Avoid
deprecatedas a label until 6.0 C# is GA.
6.0‑focused work
- Emphasize C#‑first and future‑oriented architecture:
- “This PR advances the 6.0 C#‑first architecture (services + adapters).”
- “This change is part of the 6.0 migration path from GridBuilding 5.1.”
- For labels:
track:6.0,area:gridplacement-core,area:gridplacement-godot, etc.
Cross‑cutting docs
- When documenting both lines in one place (e.g. README):
- Show a simple version status table similar to the matrix above.
- Clearly state:
- 5.1 is current and supported for GDScript.
- 6.0 C# is the future primary line.
- GDScript 6.0 is TBD.
6. Triggers to Update This Doc
Update this document when any of the following happen:
6.0 C# GA
- Mark 6.0 C# as “primary supported”.
- Officially move 5.1 into “legacy” status and reflect that in README and addon docs.
Decision on 6.0 GDScript
- If we commit to a GDScript adapter for 6.0, add:
- Expected scope.
- Support level.
- If we decide against it, state that 5.1 is the final GDScript line.
- If we commit to a GDScript adapter for 6.0, add:
Support window changes for 5.1
- If we decide an EOL date or stricter “security‑fixes only” policy, record it here.