Skip to content
Grid Building Docs

Grid Building Plugin v5.1.0

Welcome to the comprehensive documentation for Grid Building Plugin v5.0.0 - the latest stable release with major architectural improvements and enhanced features.

🎯 Version Highlights

Section titled “🎯 Version Highlights”

🏗️ Major Architectural Improvements

Section titled “🏗️ Major Architectural Improvements”
  • Complete Dependency Injection Integration with GBCompositionContainer
  • Unified Configuration System with GBConfig resource
  • Enhanced State Management with improved BuildingState lifecycle
  • Godot 4.4+ Optimizations leveraging typed data structures for better performance
  • Automatic Dependency Validation - GBInjectorSystem handles validation automatically (no manual calls needed)

🔧 Core System Enhancements

Section titled “🔧 Core System Enhancements”
  • BuildType Enum System - Replaces boolean dragging flag with comprehensive enum (SINGLE, DRAG, AREA builds)
  • Advanced Building System with comprehensive placement workflow
  • Sophisticated Grid Targeting with epsilon-filtered tile selection
  • Intelligent Placement Validation with multi-rule evaluation
  • Dynamic Indicator Management with real-time visual feedback
  • Grid-Aware Rotation System with configurable increments (4, 6, 8, 12 directions) and automatic grid alignment
  • Validation Contract: validate() methods return bool (success/failure). Use get_runtime_issues() at runtime and get_editor_issues() in the editor to collect diagnostics, log via GBLogger, and consider validation successful only when no issues remain.

🎨 UI & Usability Improvements

Section titled “🎨 UI & Usability Improvements”
  • Enhanced Placeable View UI with fixed view height, fixed icon size, and improved keyboard navigation
  • Stable Visual Feedback with consistent icon sizing across variant cycling
  • Refined Dark Theme with cyan/magenta color palette integration
  • Pre-made UI Themes - Cool Blue and Warm Earth themes included in templates for quick prototyping

📚 Documentation Improvements

Section titled “📚 Documentation Improvements”
  • End-to-End Process Documentation with detailed workflow guides
  • Comprehensive API Reference with deep links across systems
  • Comprehensive Testing Framework with 1540 tests passing at 100%
  • Performance Monitoring and debugging tools
  • Site-wide Autolinking of CamelCase class names to internal API pages or Godot docs (code blocks and existing links are respected)

📖 Documentation Sections

Section titled “📖 Documentation Sections”

🛠️ Core Systems

Section titled “🛠️ Core Systems”

🎨 Visual & UI Systems

Section titled “🎨 Visual & UI Systems”

⚙️ Configuration & Settings

Section titled “⚙️ Configuration & Settings”

🔗 API Reference

Section titled “🔗 API Reference”

Browse the complete API reference for all classes:

Core Classes

Section titled “Core Classes”

Validation & Rules

Section titled “Validation & Rules”

Visual Systems

Section titled “Visual Systems”

🚀 Getting Started

Section titled “🚀 Getting Started”
  1. Building System Process - Your first building implementation
  2. User Guides - Comprehensive usage guides
  3. Configuration - Initial configuration
  4. Dependency Injection - Understanding the DI system
  5. Try the UI Themes - Find grid_builder_cool_blue_theme.tres and grid_builder_warm_earth_theme.tres in the templates folder for quick UI styling

🧪 Testing & Validation

Section titled “🧪 Testing & Validation”
  • 1540 tests passing at 100% - Comprehensive test coverage across all systems (1410 plugin tests + 130 demo/misc tests)
  • Testing Framework - Automated testing setup with GdUnit4
  • Validation Tools - Manual validation procedures
  • Debug Tools - Debugging and troubleshooting
  • Premade testing environments (scenes) to quickly spin up common configurations (core systems, positioner stack, GBLevelContext, and GBOwner)

🔄 Migration from Previous Versions

Section titled “🔄 Migration from Previous Versions”

If you’re upgrading from an earlier version:

🤝 Support

Section titled “🤝 Support”
  • Issue tracker is private for this project. For support, use the private channel referenced in the repository README.

Version: 5.0.0
Release Date: October 2025
Godot Compatibility: 4.4+ (tested with 4.4.0, 4.4.1, 4.5 stable)