Entity-Component-System (ECS) framework for Python 3+. It aims to be flexible, performant and easy to use and learn, with a specific emphasis on game development. There is currently an example of how to integrate it with the Panda3D game engine in the examples folder, although it can also be used in conjunction with other frameworks such as Pygame or Pyglet.
This is a one-file library: just add compynent.py to your project, and import it with import compynent.
For an explanation of how ECS works and what the motivation for it is, read this article. The implementation in ComPyNent uses the approach by which entities are simply integers that refer to a list of the components attached to them.
The main class is the EntityManager class. Normally, you only need to instantiate it once.
- To create an entity, use the
create_entitymethod of EntityManager. It optionally accepts inital components as parameters - Components are simply objects with data as its members
- A system can be a function or method that is added via the
add_systemmethod of EntityManager, and it is called each time that thedo_framemethod of that instance of EntityManager is called.add_systemhas an order parameter, which is an integer that specifies the order that systems should be run in, with systems with lower order values being run first.
Example:
import compynent
ecs = compynent.EntityManager()
class MessageComponent:
def __init__(self, message):
self.message = message
entity = ecs.create_entity()
component = MessageComponent()
ecs.add_component(entity, component)
class MessageSystem():
def update(self):
for entity in ecs.get_entities():
if entity.has_component(MessageComponent):
print(ecs.get_component(entity, MessageComponent).message)
ecs.add_system(MessageSystem())
while True:
ecs.do_frame()Note: adding more than one component of the same type to a single entity will cause unexpected results.
See CONTRIBUTING.md.