Frent 0.2.1-alpha

This is a prerelease version of Frent.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Frent --version 0.2.1-alpha
                    
NuGet\Install-Package Frent -Version 0.2.1-alpha
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Frent" Version="0.2.1-alpha" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Frent" Version="0.2.1-alpha" />
                    
Directory.Packages.props
<PackageReference Include="Frent" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Frent --version 0.2.1-alpha
                    
#r "nuget: Frent, 0.2.1-alpha"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=Frent&version=0.2.1-alpha&prerelease
                    
Install Frent as a Cake Addin
#tool nuget:?package=Frent&version=0.2.1-alpha&prerelease
                    
Install Frent as a Cake Tool

Frent

A high preformance archetyped based ECS/ECF library for C#. Zero unsafe code and optimized to be just as fast.

Whaaaat?! Isn't there enough ECS libraries out there!

While Frent at its core is an archetype based ECS library, thats not why Frent was made. Frent is also an ECF - Entity Component Framework - that allows you to easily use composition for code reuse rather than inheritance with minimal boilerplate. Think Unity's Monobehavior but powered by the principles and speed of an ECS.

[!CAUTION] Frent is still in alpha, with an incomplete feature set. The api is unstable and there may be bugs!

Quick Example

using Frent;
using Frent.Components;
using System.Numerics;

using World world = new World();
Entity entity = world.Create<Position, Velocity>(new(Vector2.Zero), new(Vector2.One));

//Call Update to run the update functions of your components
world.Update();

//Alternatively, run a system by providing a delegate or a struct
world.Query((ref Position pos, ref Velocity vel) => pos.Value += vel.Delta);

// Position is <2,2>
Console.WriteLine(entity.Get<Position>().Value);

record struct Position(Vector2 Value);
record struct Velocity(Vector2 Delta) : IUpdateComponent<Position>
{
    public void Update(ref Position position) => position.Value += Delta;
}

Wanna start cooking? Check out the Cookbook!

Features

Implemented

  • Entity struct the size of a 64 bits
  • Up to 16 components per entity
  • Getting, Adding, and Removing components
  • Zero unsafe code
  • Classes as components
  • Structs as components
  • Deconstructing entities
  • Component memory stored contiguously (when using structs)
  • All entity functions are O(1) and highly optimised
  • Pass in uniform data e.g., deltaTime
  • Deconstructing entities
  • Zero reflection
  • AOT Compatible
  • Built in Uniform Provider implementation
  • Programmical Entity Creation

Future

  • Multithreading
  • Entity relationships
  • Tests
  • Entity Tag
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Frent:

Repository Stars
Doraku/Ecs.CSharp.Benchmark
Benchmarks of some C# ECS frameworks.
Version Downloads Last updated
0.5.5.1-beta 153 6 days ago
0.5.5-beta 149 6 days ago
0.5.4.3-beta 503 a month ago
0.5.4.2-beta 424 a month ago
0.5.4.1-beta 427 a month ago
0.5.4-beta 240 a month ago
0.5.3.1-beta 233 a month ago
0.5.3-beta 115 a month ago
0.5.2-beta 132 a month ago
0.5.1-beta 123 a month ago
0.5.0-beta 84 a month ago
0.4.2.1-beta 175 2 months ago
0.4.2-beta 165 2 months ago
0.4.1.2-beta 74 2 months ago
0.4.1.1-beta 55 2 months ago
0.4.1-beta 90 2 months ago 0.4.1-beta is deprecated because it has critical bugs.
0.4.0-beta 164 2 months ago 0.4.0-beta is deprecated because it has critical bugs.
0.3.3.3-beta 61 3 months ago
0.3.3.2-beta 59 3 months ago
0.3.3.1-beta 52 3 months ago
0.3.3-beta 51 3 months ago
0.3.2-beta 57 3 months ago
0.3.1-beta 74 3 months ago
0.3.0-beta 53 3 months ago
0.2.3-alpha 56 4 months ago
0.2.2-alpha 60 4 months ago
0.2.1-alpha 52 4 months ago
0.2.0-alpha 65 4 months ago
0.1.4-alpha 65 4 months ago
0.1.3-alpha 67 4 months ago
0.1.2-alpha 65 4 months ago
0.1.1-alpha 62 4 months ago
0.1.0-alpha 76 4 months ago