Flecs.NET

Docs · Examples · Discord

Flecs.NET is a high-level wrapper for flecs. Low-level bindings to the C api are included and generated with Bindgen.NET. Native libraries are cross-compiled with Vezel-Dev's Zig Toolsets.

Show me the code!

using Flecs.NET.Core;

// Main Function
using World world = World.Create();

Entity entity = world.Entity()
    .Set(new Position(10, 20))
    .Set(new Velocity(1, 2));

Query query = world.Query(filter: world.FilterBuilder<Position, Velocity>());

query.Each((ref Position p, ref Velocity v) =>
{
    p.X += v.X;
    p.Y += v.Y;
});

return 0;

// Components
public struct Position(float x, float y)
{
    public float X { get; set; } = x;
    public float Y { get; set; } = y;
}

public struct Velocity(float x, float y)
{
    public float X { get; set; } = x;
    public float Y { get; set; } = y;
}

Overview

Flecs.NET - High-level C# port of the C++ wrapper

Compatible with .NET Standard 2.1 and NativeAOT
Near feature parity with the C++ API
Struct-based API with minimal GC interaction
Supports both unmanaged and managed types as components
Implicitly registers components on-the-fly

Flecs.NET.Bindings - Low-level bindings of the C API

Build your own wrapper to suite your personal needs
Auto-generated bindings for the entire flecs API
Fully blittable interface with no runtime marshalling

Flecs.NET.Native - Precompiled native libraries

Provides both shared and static libraries for Windows, MacOS, and Linux
Packaged with Zig for dependency free cross-compilation everywhere

NuGet

You can download the nuget package and use Flecs.NET right away!

Flecs.NET (Wrapper + Bindings + Native Libraries): Release | Debug

dotnet add PROJECT package Flecs.NET.Release --version *-*

Flecs.NET.Bindings (Bindings + Native Libraries): Release | Debug

dotnet add PROJECT package Flecs.NET.Bindings.Release --version *-*

Flecs.NET.Native (Native Libraries): Release | Debug

dotnet add PROJECT package Flecs.NET.Native.Release --version *-*

Flecs.NET provides both release and debug packages for nuget. To include both of them in your project based on your build configuration, use the package references below. The latest stable or prerelease versions will be added to your project.

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net7.0</TargetFramework>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Flecs.NET.Debug" Version="*-*" Condition="'$(Configuration)' == 'Debug'" />
        <PackageReference Include="Flecs.NET.Release" Version="*-*" Condition="'$(Configuration)' == 'Release'" />
    </ItemGroup>

</Project>

GitLab Package Registry

For more up-to-date packages, development builds are available on the GitLab package registry. To add the development feed to your project, add the GitLab link below as a restore source. You can now reference any package version listed here!

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net7.0</TargetFramework>
        <RestoreSources>$(RestoreSources);https://gitlab.com/api/v4/projects/51698729/packages/nuget/index.json</RestoreSources>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Flecs.NET.Debug" Version="3.2.8-dev-2023-10-30-11-06-14"/>
    </ItemGroup>

</Project>

Warning

Development feed packages may be deleted without warning to free up space.

Unity Package Manager

The Flecs.NET Unity Package is hosted on github and can be downloaded using the URL below.

Open the package manager window Window > Package Manager
Click the + icon
Click Add package from git URL...
Enter the Flecs.NET.Unity git URL

https://github.com/BeanCheeseBurrito/Flecs.NET.Unity.git

Note

Only Windows, MacOS, and Linux builds on x64 Mono are supported. IL2CPP, web, and mobile support are planned for the future.

Running examples

Note Flecs native libraries need to be built before running any of the examples. See step Compile flecs on how to compile them.

To run any of the example programs, use dotnet runand set the "Example" property to the example's path relative to the Flecs.NET.Examples project. Each level of the path must be separated by an underscore.

Example:

dotnet run --project src/Flecs.NET.Examples --property:Example=Cpp_Entities_Basics

Building from source

Clone the repo

Clone the repo and it's submodules.

git clone --recursive https://github.com/BeanCheeseBurrito/Flecs.NET.git
cd Flecs.NET

Restore dependencies

Run the following command on the solution to restore all project dependencies.

dotnet restore

Generate bindings

Generate the binding code. Bindings are generated with Bindgen.NET.

Note The binding generator needs access to system headers on MacOS. Ensure that XCode is installed.

dotnet run --project src/Flecs.NET.Bindgen

Compile flecs

Compile the native libraries. The zig compiler will automatically be downloaded and cached in your local nuget package folder. Native libraries will be cross-compiled for linux, macos, and windows.

dotnet build src/Flecs.NET.Native

Reference the project

Reference the project and import the native libraries.

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net7.0</TargetFramework>
    </PropertyGroup>

    <Import Project="PATH/Flecs.NET/src/Flecs.NET.Native/Flecs.NET.Native.targets" />

    <ItemGroup>
        <ProjectReference Include="PATH/Flecs.NET/src/Flecs.NET/Flecs.NET.csproj" />
    </ItemGroup>

</Project>

Contributing

Feel free to open an issue or pull request. All contributions are welcome!

Ways to contribute:

Bug Fixes/Reports
Feature Requests
Documentation
Examples/Snippets
Demos
Typo Corrections

MUN1Z / Flecs.NET