Grid Building Plugin v5.0.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

🏗️ 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

🔧 Core System Enhancements

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
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.

📚 Documentation Improvements

End-to-End Process Documentation with detailed workflow guides
Comprehensive API Reference with deep links across systems
Comprehensive Testing Framework with automated validation
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

🛠️ Core Systems

Building System Process - Complete placement workflow from start to finish
Placement Chain - Detailed placement processing pipeline
Manipulation System - Object manipulation and movement
Grid Targeting - Advanced grid positioning and validation

🎨 Visual & UI Systems

Indicator Management - Visual feedback and status indicators
UI Components - User interface elements and controls

⚙️ Configuration & Settings

Configuration Guide - System configuration and setup

🔗 API Reference

Browse the complete API reference for all classes:

Go to the API Home: API Reference Index

Core Classes

BuildingSystem - Main building system coordinator
GBConfig - Unified configuration resource
BuildingState - Building session state management
GridTargetingSystem - Grid positioning and targeting

Validation & Rules

PlacementValidator - Placement validation engine
TileCheckRule - Individual tile validation rules
PlacementRule - General placement rules

Visual Systems

IndicatorManager - Visual indicator management
RuleCheckIndicator - Individual rule indicators
GBCursorChanger - Cursor management system

🚀 Getting Started

Installation Guide - Quick setup and installation
Basic Usage - Core concepts and basic usage
Configuration - Initial configuration
First Building System - Your first building implementation

🧪 Testing & Validation

Testing Framework - Automated testing setup
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

If you’re upgrading from an earlier version:

Migration Guide - Step-by-step migration instructions
Breaking Changes - Important changes to be aware of

🤝 Support

Issue tracker is private for this project. For support, use the private channel referenced in the repository README.

Version: 5.0.0 (Development)
Release Date: September 2025
Godot Compatibility: 4.4+ - Previous versions will not be compatible.