CinderEngine 2.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CinderEngine --version 2.0.1
                    


                    

                
NuGet\Install-Package CinderEngine -Version 2.0.1
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="CinderEngine" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CinderEngine" Version="2.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CinderEngine" />
                    


                            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 CinderEngine --version 2.0.1
                    


                    

                
#r "nuget: CinderEngine, 2.0.1"
#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. 
#:package CinderEngine@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CinderEngine&version=2.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CinderEngine&version=2.0.1
                    


                            Install as a Cake Tool

Cinder Engine

The Cinder Engine is an engine purpose-built for choice-based storygames made in .NET 10.0.

Made to be easy yet flexible, it allows the writer to just worry about writing without needing to worry about actual programming unless they wish for extended logic.

The engine itself does implement Lua as a scripting language. Information can be found in the Documentation.

Cinder Engine requires a frontend for any story file to be viewed. The official one is Flame.

Implementation

For any frontend implementation, you need to implement at bare minimum:

  • A way to show the text.
    • GetText()
  • A way to show and interact with options
    • GetOptionLabels() for getting the option labels.
    • ParseSelectedOption(int) for interaction.

To initalize the engine, you can do the following:

  • Game _game = new("/path/to/story_file")
  • Game _game = new("/path/to/story_file", "frameworkStandard")
  • Game _game = new("/path/to/story_file", "frameworkStandard", [luaFunction1, luaFunction2])
    • luaFunctionX expects to be a CustomLuaFunction object. See the documentation on scripting for further information.

And then _game.ResetEngine() to initalize it.

You can also see Flame's implementation for reference on how to achieve this.

Installing

Download the nuget package CinderEngine

dotnet add package CinderEngine

Building

Prerequisites

Clone the repo:

git clone https://codeberg.org/COIFF-Project/CinderEngine

Move into the build directory:

cd CinderEngine/CinderEngine

Build the library in Debug:

dotnet build

The resulting binary can be found in CinderEngine\bin\net10.0.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.0 89 2/8/2026
2.0.1 91 2/8/2026
2.0.0 102 2/7/2026
1.0.0.1 94 2/5/2026
1.0.0 87 2/5/2026