Getting Started Guides
Welcome to the GridPlacement documentation! These guides will help you understand the core concepts and get up and running quickly.
🚀 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.
🔗 Runtime Chains
Placement Chain
End-to-end flow: select → validate → indicators → execute.
Targeting Chain
Input → snap → hit-test → target snapshot.
Grid Chain
Grid state, bounds, occupancy, and coordinate math.
Manipulation Chain
Move / demolish / info flows built on targeting + grid + rules.
🎯 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
🎒 Demo Integration
GridPlacementInventory (Demo)
How the demo inventory layer plugs into placement rules, and how to replace it for production.
API Reference
Complete API documentation for all classes and methods.
Examples
Code examples and implementation patterns for common use cases.
🤝 Need Help?
- GitHub Issues: Report bugs or request features
- Discussions: Ask questions and share ideas
- API Reference: Browse the complete API documentation
Ready to Start Building?
Begin with the project architecture guide to understand the system structure, then dive into specific topics based on your needs.