HiWill/flecs-cs

Semi-automatically updated C# bindings for flecs https://github.com/SanderMertens/flecs with native dynamic link libraries.

flecs-cs

Semi-automatically updated C# bindings for https://github.com/SanderMertens/flecs with native dynamic link libraries. The lower-level unsafe C# "bindings" are automatically generated but the higher level "wrapper" is manually written.

How to use

From source

1. Download and install .NET 6.
2. Fork the repository using GitHub or clone the repository manually with submodules: git clone --recurse-submodules https://github.com/flecs-hub/flecs-cs.
3. Build the native library by running library.sh. To execute .sh scripts on Windows, use Git Bash which can be installed with Git itself: https://git-scm.com/download/win. The library.sh script requires that CMake is installed and in your path.
4. To setup everything you need: Either (1), add the src/cs/production/Flecs/Flecs.csproj C# project to your solution as an existing project and reference it within your own solution, or (2) import the MSBuild flecs.props file which is located in the root of this directory to your .csproj file. See the flecs.csproj file for how to import the flecs.props directly.

Developers: Documentation

C# Examples

For examples in C#, see ./src/cs/examples, or open up the solution .sln file in VisualStudio / Rider.

C Examples

To learn how to use flecs directly, check out the https://github.com/SanderMertens/flecs#documentation.

Bindings

For more information on how C# bindings work, see C2CS, the tool that generates the bindings for flecs and other C libraries.

License

flecs-cs is licensed under the MIT License (MIT) - see the LICENSE file for details.

flecs itself is licensed under MIT (MIT) - see https://github.com/SanderMertens/flecs/blob/master/LICENSE for more details.