Godot RTS Entity Controller Documentation

Welcome to the Godot RTS Entity Controller addon documentation. This addon is a comprehensive toolkit for building Real-Time Strategy (RTS) games in Godot and includes ready to use components for selecting, moving, attack units or buildings and casting abilities.

The play and feel of these components (especially the movement and combat system) is heavily inspired by Starcraft 2, which should make people familiar with it feel right at home. This means you will find all the basic controlling blocks, such as moving, patrolling, move-attacking or casting abilities for units (or buildings) that you are used from Starcraft 2.

As a result one of the highlights of this addon is the responsive control over units, best suited for RTS or RTT games with unit counts in the tens or low hundreds. The systems in this addon were not developed for armies of thousands of units, but rather optimized for a high degree of control, modularity and customization over the behaviours of units.

Quick Start

New to the addon? Start here:

1. Getting Started - Installation and basic setup
2. Core Concepts - Understand the architecture

Documentation Structure

Systems & Features

• Player Input System - Selection, movement commands, and camera control
• Entities - Creating entities using building blocks
• Selection System - Unit selection and group management
• Movement & Navigation - Unit pathfinding and movement
• Abilities System - Creating and using custom abilities
• Combat System - Auto targeting, weapon and combat systems
• Autoloads - Controller and utility logic

Components Deep Dive

• Component Overview - Component system overview
• Selectable Component - Making units selectable
• Movable Component - Movement capabilities
• Health Component - Health and damage
• Defense Component - Defense and damage reduction
• Attack Component - Attacking and weapons
• Visual Component - Pivots and visuals

Advanced Topics

• Spatial Hashing - Performance optimization

Reference

• Best Practices - Tips and patterns
• Troubleshooting - Common issues and solutions

Features

• Selection System - Select individual or multiple units with box selection
• Movement & Navigation - Pathfinding and group movement
• Combat - Attack systems, abilities, and damage
• Animation - AnimationTree integration for smooth animations
• Events - Decoupled communication via event bus
• Performance - Spatial hashing for efficient queries
• Extensible - Component-based architecture for easy customization

Downloadable Content

• Godot Addon: All scripts, basic unit templates, and essential assets are included free in the open source project on Github
• Free Demo: A free executable demonstrating more advanced units and abilities can be found on itch.io
• Example Project (Paid): An example project containing more advanced units and abilities, as well as assets, can be found on itch.io

Support

For issues, questions, or suggestions, please refer to the Troubleshooting section or check the repository issues.