EcsRx is a reactive take on the common ECS pattern with a well separated design using rx and adhering to IoC and other sensible design patterns.
This is the future core library for ecsrx, the previous unity version will become a unity flavour of the ecsrx framework.
We have split this out and the unity version is available @ grofit/ecsrx.unity
- Simple ECS interfaces to follow
- Fully reactive architecture
- Favours composition over inheritance
- Adheres to inversion of control
- Lightweight codebase
- Built in support for events (raise your own and react to them)
- Built in support for pooling (easy to add your own implementation or wrap 3rd party pooling tools)
- Built in support for plugins (wrap up your own components/systems/events and share them with others)
The core framework is meant to be used primarily by .net applications/games, there is a unity specific version here
The library was built to support .net standard 2.0, so you can just reference the assembly, and include a compatible rx implementation.
It is advised to look at the examples, which show the bare bones required setup, this is jus an example and we will look at having more support for specific frameworks going forward.
If you are using unity it is recommended you just ignore everything here and use the instructions on the ecsrx.unity repository.
public class HealthComponent : IComponent
{
public int CurrentHealth { get; set; }
public int MaxHealth { get; set; }
}You implement the IComponent interface which marks the class as a component, and you can optionally implement IDisposable if you want to dispose stuff like so:
public class HealthComponent : IComponent, IDisposable
{
public ReactiveProperty<int> CurrentHealth { get; set; }
public int MaxHealth { get; set; }
public HealthComponent()
{ CurrentHealth = new ReactiveProperty<int>(); }
public void Dispose()
{ CurrentHealth.Dispose; }
}Any component which is marked with IDisposable will be auto disposed of by entities.
public class CheckForDeathSystem : IReactToEntitySystem
{
public IGroup TargetGroup => new Group(typeof(HealthComponent)); // Get any entities with health component
public IObservable<IEntity> ReactToEntity(IEntity entity) // Explain when you want to execute
{
var healthComponent = entity.GetComponent<HealthComponent>();
return healthComponent.CurrentHealth.Where(x => x <= 0).Select(x => entity);
}
public void Execute(IEntity entity) // Logic run whenever the above reaction occurs
{
entity.RemoveComponent<HealthComponent>();
entity.AddComponent<IsDeadComponent>();
}
}Systems are conventional, so there are many built in types like IReactToEntitySystem, IReactToGroupSystem, IManualSystem and many others, but you can read about them in the docs/systems, you can add your own conventional systems by extending ISystem and systems are handled for you by the ISystemExecutor.
Check the examples for more use cases, and the unity flavour of ecsrx which has more examples and demo projects, and drop into the gitter channel to ask any questions.
If you want to run the examples then just clone it and open examples project in the src folder, then run the examples, I will try to add to as the library matures.
There are also a suite of tests which are being expanded as the project grows, it was written with testability in mind.
See the docs folder for more information. (This will grow)