Faerie.Terminal.Headless 0.2.0

Prefix Reserved

dotnet add package Faerie.Terminal.Headless --version 0.2.0

NuGet\Install-Package Faerie.Terminal.Headless -Version 0.2.0

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="Faerie.Terminal.Headless" Version="0.2.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Faerie.Terminal.Headless" Version="0.2.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Faerie.Terminal.Headless" />
                    

                            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 Faerie.Terminal.Headless --version 0.2.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Faerie.Terminal.Headless, 0.2.0"

#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 Faerie.Terminal.Headless@0.2.0

#: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=Faerie.Terminal.Headless&version=0.2.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Faerie.Terminal.Headless&version=0.2.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Faerie.Terminal.Headless

Headless host for the Faerie text-adventure engine: replay commands from a script file and write a plain-text session transcript. No window, no Avalonia — suitable for automated playthroughs, regression tests, and CI.

dotnet add package Faerie.Terminal.Headless

In your game or test project

using Faerie.Terminal.Headless;

Game game = MyGame.Build();
int exit = HeadlessRunner.Run(game, new HeadlessOptions
{
    ScriptPath = "commands.txt",
    TranscriptPath = "session.txt",
    RandomSeed = 42   // optional, for reproducible rolls
});

Parse CLI flags with HeadlessArgs.TryParse(args, out HeadlessOptions? options, out string? error) — the sample apps branch to headless mode when --script is present.

Command-line usage (sample apps)

dotnet run --project src/Faerie.Samples.Zork -- --script walkthrough.txt --transcript session.txt

Script lines starting with # or ; are comments; blank lines are skipped. Each command is logged as > command in the transcript, followed by stripped game output.

Use - for standard input/output:

type commands.txt | dotnet run --project src/Faerie.Samples.Zork -- --script - -o -

This package depends only on Faerie (which pulls in the engine). It does not reference Avalonia.

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.

net10.0
- Faerie (>= 0.2.0)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Faerie.Terminal.Headless:

Package	Downloads
Faerie.Terminal.Avalonia Avalonia "fake terminal" front end for the Faerie text-adventure engine: renders Faerie.Terminal's character-cell framebuffer as a true-colour text screen with blink/underline/bold/inverse, scrollback, zoom, title/status bars, and a game-supplied or built-in retro font. Bundles 20 curated open-licensed fonts (IBM PC, BBC, and 8-bit classics).	373

GitHub repositories

This package is not used by any popular GitHub repositories.