Grid Placement

GridPlacement Plugin Docs

This docs/ folder contains plugin-local documentation for GridPlacement 6.0. Use it when working on this plugin’s code, tests, and Godot integration.

Track selector (start here)

  • 5.1/README.md — GridBuilding 5.1 (GDScript) maintenance line entrypoint
  • 6.0/README.md — GridPlacement 6.0 (C#-first) line entrypoint

Pattern reference:

  • DOCS_ORGANIZATION_PATTERN.md — how this docs tree is organized and why

Workflow entrypoints (start here)

1
2
3

# Demo + GDScript health (scan/smoke/full) via the short workflow script
./scripts/testing/demo_doctor.sh --help
./scripts/testing/demo_doctor.sh all

Config:

  • scripts/testing/demo_doctor.yaml

Layout (Layer + Topic)

  • Core/
    • Core C# architecture and services for GridPlacement.
    • Core test strategy and internals.
  • Godot/
    • Godot adapter nodes and scene wiring.
    • Targeting, placement controllers, and engine-facing notes.
  • gdscript/
    • Legacy GDScript addon docs and migration notes.
  • Migration/
    • Migration status and priorities for legacy classes.
    • e.g. MIGRATION_CLASS_PRIORITY.md.
  • design/
    • Local design docs for 6.0 features.
    • e.g. GRID_TARGET_SENSOR_DESIGN.md.
  • Roadmap/
    • Plugin-specific roadmap and production readiness.
    • e.g. ROADMAP.md, PRODUCTION_ROADMAP.md.
  • reports/
    • Generated reports (integrity, coverage, health) for this plugin.
  • _archive/
    • Historical or retired docs kept for reference only.

Single-file guides in this folder

  • GITHUB_SWE_SETUP.md — full agent/developer setup guide (build, test, CI, workflows).
  • LOCAL_CI.md — focused reference for scripts/ci-*.sh usage and environment variables.
  • GRIDBUILDING_VERSION_LIFECYCLE.md — internal policy for 5.1 vs 6.0 lifecycle and wording.
  • WORKSPACE_README.md — VS Code workspace overview for this plugin; treat as workspace-level infra docs rather than in-game/runtime design.

Workspace-wide standards and published docs live under the root /home/chris/game_dev/docs/ folder. See in particular:

  • docs/README.md — workspace docs root overview.
  • docs/internal/architecture/PLUGINS_AND_PROJECT_DOCS_STRUCTURE.md — shared pattern for organizing plugin and project docs.