Edit of asset "GECS" Accepted
| Old/Current | New/Edit | |
|---|---|---|
| Title | GECS | |
| Description |
GECS - Godot Entity Component System A lightweight and performant ECS framework that integrates seamlessly with Godot 4.x, built to leverage Godot’s node system. It supports: - Full integration with Godot’s node system - Query-based filtering of entities with optimized component indexing - System groups for organized processing - Component resources that work in the editor - Straightforward setup with automatic node management - Clear examples (Zombies Ate My Neighbors, a 2D Breakout clone) OVERVIEW GECS follows the Entity Component System (ECS) pattern: - Entity: A container (a node extending Entity) representing an object. - Component: A data container resource (extends Component) with properties but no logic. - System: A node (extends System) that defines a query for relevant entities and the logic to run on them. - World: A central node (extends World) that manages entities and systems. FEATURES - Components: Simple resources, easy to edit in the Godot inspector. - Entities: Node scenes that extend Entity and automatically synchronize component data. - Systems: Nodes that define queries (for example using with\_all, with\_any) and process matching entities. - System Groups: Specify a group name such as "physics" or "gameplay" to organize and process systems at different times. - ECS Singleton: Global access to your current World, allowing you to call ECS.process(delta, group). - Relationship Support: Use relationships as specialized resources to link entities. - Advanced Queries: Use with\_relationship, with\_reverse\_relationship, and various conditions to refine your entity matching. WHY USE GECS - Improved code organization and maintainability - Clean separation of data (components) and logic (systems) - Intuitive queries for selecting and managing entities - Works naturally with Godot’s scene and node structure GETTING STARTED 1. Place the GECS addon in your project’s addons folder. 2. Enable the plugin in Project Settings > Plugins. 3. Ensure ECS.gd is autoloaded (done automatically when enabling the plugin). 4. Create your own entities, components, and systems. 5. Place a World node, attach your systems and entities, then call ECS.process(delta, group) as needed. SIMPLE STEPS - Create Components, for example Velocity or Bounce, each with exported properties. - Create Entities, adding the desired components in the inspector. - Create Systems, define queries such as with\_all, and implement the logic. - Add Systems to your World node, optionally setting a group. - Process them via ECS.process(delta, "group\_name"). USE CASES - 2D and 3D games needing modular and scalable code - Clean separation of concerns in larger projects - Editor-based design of components without heavy scripting - Simplified debugging of component data SPECIAL FEATURES - Relationship-based queries for advanced linking of entities - System groups for controlling update order - Resource-based components that can be instanced or shared - Editor support for exporting component properties CONCLUSION GECS streamlines development with a concise Entity Component System approach that fits naturally into Godot’s node structure. Build maintainable, modular games with flexible queries, reusable data containers, and powerful system organization. |
# GECS > Godot Entity Component System A lightweight, performant ECS framework for Godot 4.x that integrates seamlessly with Godot's node system. ## Features - Full integration with Godot's node system - Query-based entity filtering with optimized component indexing - System groups for organized processing - Component resources that work in the editor - Easy setup with automatic node management ## Introduction GECS is an Entity Component System (ECS) framework designed for the Godot Engine. It provides a simple yet powerful way to organize your game logic using the ECS pattern, allowing for better code organization, reusability, and scalability. This documentation will guide you through the setup and usage of the GECS addon, providing examples from a sample game project to illustrate key concepts. ## Installation 1. **Download the Addon**: Clone or download the GECS addon and place it in your project's `addons` folder. 2. **Enable the Addon**: In the Godot editor, go to `Project > Project Settings > Plugins`, and enable the `GECS` plugin. 3. **Autoload ECS**: The addon requires the `ECS` singleton to be autoloaded. This should be handled automatically when you enable the plugin. If not, go to `Project > Project Settings > Autoload`, and add `ECS` pointing to `res://addons/gecs/ecs.gd`. 4. **Configure Entity Base Type**: GECS allows you to set the base type for entities. In `Project > Project Settings > GECS`, set `Entity Base Type` to `Node2D` or `Node3D` depending on your project's requirements. ## Getting Started ### Basic Concepts > Each class has a full set of in-editor Godot documentation. Check there as well! Before diving into the usage of the GECS addon, it's important to understand the basic concepts of an Entity Component System (ECS): - **Entity**: A container or placeholder that represents an object in your game. Entities can have multiple components added to them to define their behavior and properties. - **Component**: A data container that holds specific attributes or properties. Components do not contain game logic. - **System**: A system contains the logic that operates on entities with specific components. - **World**: The context in which entities and systems exist and interact. - **Query**: A way to query for specific entities in the world based on the components they contain. - **ECS Singleton**: Provides global access to the current `World` instance and offers utility functions for processing. |
| Category | Scripts | |
| License | CC0 | |
| Repository Provider | GitHub | |
| Repository Url | https://github.com/csprance/gecs | |
| Issues Url | https://github.com/csprance/gecs/issues | |
| Godot version | Godot 4.0 | |
| Version String | 3.5.1 | 2.0.0 |
| Download Commit | 284d3144a51bfb62145c5b4c05b297172decaff2 | 24a234a782f4a22c54b380e9404ee44b699d0b0d |
| Download Url (Computed) | https://github.com/csprance/gecs/archive/284d3144a51bfb62145c5b4c05b297172decaff2.zip | https://github.com/csprance/gecs/archive/24a234a782f4a22c54b380e9404ee44b699d0b0d.zip |
| Icon Url |
https://raw.githubusercontent.com/csprance/gecs/refs/heads/main/addons/gecs/assets/logo.png
|
|