# [Frent](https://itsbuggingme.github.io/Frent/) [](https://www.nuget.org/packages/Frent/) [](https://www.nuget.org/packages/Frent/)    A high preformance, low memory usage, archetyped based [ECF](https://itsbuggingme.github.io/Frent/docs/ecf.html)/[ECS](https://github.com/SanderMertens/ecs-faq) library for C#. *Whaaaat?! Arent there enough ECS libraries out there!* While Frents implementation is an archetype based ECS, thats not why Frent was made. Frent is primarily an ECF - Entity Component Framework - that allows you to easily use composition for code reuse rather than inheritance with minimal boilerplate. Think Unitys Monobehavior powered by the principles and speed of an ECS, as well as less boilerplate. Want to write systems anyways? Frent also has a Systems API that allows you to query entities in the style of an ECS. > [!CAUTION] > Frent is still in beta and is not completely stable. ## Quick Example ```csharp using Frent; using Frent.Components; using System.Numerics; World world = new World(); Entity entity = world.Create(new(Vector2.Zero), new(Vector2.One)); //Call Update to run the update functions of your components world.Update(); // Position is (1, 1) Console.WriteLine(entity.Get()); record struct Position(Vector2 Value); record struct Velocity(Vector2 Delta) : IComponent { public void Update(ref Position position) => position.Value += Delta; } ``` Wanna learn more? Check out the [docs](https://itsbuggingme.github.io/Frent/docs/getting-started.html)! There is also a [Monogame](https://github.com/itsBuggingMe/Frent/blob/master/Frent.Sample/Asteroids/AsteroidsGame.cs) and [Godot](https://github.com/itsBuggingMe/FrentGodotSample) sample. ## Preformance Frent is a lot faster than most C# ECS implementations - [Benchmark](https://github.com/Doraku/Ecs.CSharp.Benchmark). # Features ## Implemented - [x] Entity struct the size of a 64 bits - [x] Up to 127 components per entity - [x] Getting, Adding, and Removing components - [x] Classes as components - [x] Structs as components - [x] Deconstructing entities - [x] Component memory stored contiguously (when using structs) - [x] Get/Has/TryGet O(1) and highly optimised - [x] Pass in uniform data e.g., `deltaTime` - [x] Deconstructing entities - [x] Zero reflection - [x] AOT Compatible - [x] Built in Uniform Provider implementation - [x] Non-Generic Entity Creation - [X] Entity Tags - [X] World Update Filtering - [X] Command buffer - [X] Component/Tag Add/Remove Events (with generic version) - [X] Automatic structual change management during updates ## Future - [ ] Comprehensive docs - [ ] 100% Test coverage - [ ] More samples, examples, & explanations! - [ ] Multithreading - [ ] `EntityMarshal` and `WorldMarshal` for even faster speeds! # Contributing Wanna help? Report bugs, suggest APIs, and give general feedback. Just open an issue before starting a large feature.
