THE COOKBOOK - Tutorials and Tricks

Can't wait? Try fennecs for yourself as you flip through the courses of our Cookbook.

🦊 1, 2, 3 - gravity!

var stream = world.Stream<Vector3>();

stream.For(Time.Delta, (dt, ref velocity) => 
{
    velocity.Y -= 9.81f * dt;
});

(🧓 same, in classic C#)

var stream = world.Stream<Vector3>();

stream.For(
    uniform: Time.Delta, 
    action: (float dt, ref Vector3 velocity) => 
    {
        velocity.Y -= 9.81f * dt;
    }
);

BEST SERVED WITH C# 14

fennecs is at its best with C# 14 or later (the default language version for .NET 10). Since C# 14, lambda parameters may omit their types even when they carry modifiers like ref and in – so runner delegates shrink from (float dt, ref Vector3 velocity) to (dt, ref velocity). The docs use this short form throughout.

The difference on older C#: before C# 14, any lambda parameter with a ref/in/out modifier had to spell out its type (and then all parameters needed explicit types). Everything in these docs still works on C# 12/13 – just write the parameter types back in, exactly as shown in the "classic" tab above.

THE DOCUMENTATION - (you're in it now!)

All the deets & don'ts and core facets of the fennecs API. Use the navigation menu on the left!

Where to begin?

👉 Concepts - an overview of fennecs (and ECS in general)

👉 Advanced - sharp tools for big simulations (new: Aspects)

The nuget package also has extensive XMLdoc coverage to keep you informed while you code and explore in your IDE of choice. (neovim obviously, but also Rider or VSCode, any IDE, really)

THE EXAMPLES - Smol, Shiny Demos

The Demos category has concrete examples for a growing list of renderers and game engines! Something useful and something pretty to look at at the same time? It cannot be possible, and yet!

THE REST

The Misc section contains our Glossary of terms and a few heartfelt words of thanks., and anything else that didn't fit elsewhere. Like our Roadmap and Changelog!