ecs-pattern 1.3.0

Intro

It is great for describing a dynamic virtual world.

Basic principles of ECS:

• Composition over inheritance

• Data separated from logic (Data Oriented Design)

Installation

$ pip install ecs-pattern

Guide

The library provides you with 5 tools:

from ecs_pattern import component, entity, EntityManager, System, SystemManager

• Describe components - component

• Describe entities based on components - entity

• Distribute the responsibility of processing entities by systems - System

• Store entities in entity manager - EntityManager

• Manage your systems with SystemManager

Examples

• Pong: game - pygame + ecs_pattern

• Snow day: scene - pygame + ecs_pattern

• Trig fall: commercial game - pygame + ecs_pattern + numpy

Advantages

• Memory efficient - Component and Entity use dataclass

• Convenient search for objects - by entity class and by entity components

• Flexibility - loose coupling in the code allows you to quickly expand the project

• Modularity - the code is easy to test, analyze performance, and reuse

• Execution control - systems work strictly one after another

• Following the principles of the pattern helps to write quality code

• Convenient to parallelize processing

• Compact implementation

Difficulties

• It can take a lot of practice to learn how to cook ECS properly

• Data is available from anywhere - hard to find errors

Newbie mistakes

• Inheritance of components, entities, systems

• Ignoring the principles of ECS, such as storing data in the system

• Raising ECS to the absolute, no one cancels the OOP

• Adaptation of the existing project code under ECS “as is”

• Use of recursive or reactive logic in systems

• Using EntityManager.delete in get_by_class, get_with_component loops

Good Practices

• Use “Singleton” components with data and flags

• Minimize component change locations

• Do not create methods in components and entities

• Divide the project into scenes, a scene can be considered a cycle for the SystemManager with its EntityManager

• Use packages to separate scenes

Project tree example:

/common_tools
    __init__.py
    resources.py
    i18n.py
    gui.py
    consts.py
    components.py
    math.py
/menu_scene
    __init__.py
    entities.py
    main_loop.py
    surfaces.py
    systems.py
/game_scene
    __init__.py
    entities.py
    main_loop.py
    surfaces.py
    systems.py
main.py

Releases

History of important changes: release_notes.rst

Help the project

• Found a bug or have a suggestion - issue / merge request 🎯

• There is nothing to help this project with - help another open project that you are using ✋

• Nowhere to put the money - spend it on family, friends, loved ones or people around you 💰

• Star the project ⭐