GridPlacement 6.0 (formerly GridBuilding)
Development โš ๏ธ GridPlacement 6.0 documentation is in active development. APIs and content may change, and the site may be temporarily unstable.

Getting Started Guides

Welcome to the Grid Building Plugin documentation! These guides will help you understand the core concepts and get up and running quickly.

โ„น๏ธ
Minimum Godot version
v5.0.0 targets Godot 4.4+ as the minimum supported version.

๐Ÿš€ Quick Start

Installation & Setup

Learn how to install the plugin in your Godot project and configure the basic settings.

Basic Grid Setup

Create your first grid and understand the fundamental building blocks of the system.

Input & Interaction

Set up user input handling and create interactive building mechanics.

๐Ÿ“š Core Concepts

Grid System

Understanding grids, cells, and the core grid building mechanics.

Building System

How the building system works and how to customize it for your needs.

Targeting & Selection

Grid targeting, cell selection, and visual feedback systems.

๐ŸŽฏ Advanced Features

Isometric Grids

Implement isometric grid systems with proper coordinate transformation.

Persistence

Save and load grid states, building data, and game progress.

Extending the Plugin

Create custom components, extend functionality, and add new features.

โš™๏ธ Configuration & Customization

Settings & Configuration

Configure grid settings, visual options, and behavior parameters.

Dependency Injection

Understanding and using the dependency injection system.

Collision Mapping

Set up collision detection and grid-based physics interactions.

๐Ÿ”„ Migration & Upgrades

5.0 โ†’ 6.0 Migration

Migrate from GDScript 5.0.0 to C# 6.0.0 with our comprehensive migration guide.

Migration Cheat Sheet

Quick reference for migration commands, common fixes, and troubleshooting.

Migration Configuration

Configure the enhanced migration tool with TOML, JSON, or YAML settings.

๐Ÿงช Testing & Quality

Testing with GDUnit

Write and run tests for your grid building implementations.

๐Ÿ“– Reference Materials

API Reference

Complete API documentation for all classes and methods.

Examples

Code examples and implementation patterns for common use cases.


๐Ÿค Need Help?


Ready to Start Building?

Begin with the project architecture guide to understand the system structure, then dive into specific topics based on your needs.