SadConsole 10.0.0-beta1-debug

This is a prerelease version of SadConsole.

There is a newer version of this package available.
See the version list below for details.

dotnet add package SadConsole --version 10.0.0-beta1-debug

NuGet\Install-Package SadConsole -Version 10.0.0-beta1-debug

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="SadConsole" Version="10.0.0-beta1-debug" />

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

paket add SadConsole --version 10.0.0-beta1-debug

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

#r "nuget: SadConsole, 10.0.0-beta1-debug"

#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.

// Install SadConsole as a Cake Addin
#addin nuget:?package=SadConsole&version=10.0.0-beta1-debug&prerelease

// Install SadConsole as a Cake Tool
#tool nuget:?package=SadConsole&version=10.0.0-beta1-debug&prerelease

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

SadConsole Logo

SadConsole is a generic library that emulates old-school console game systems. It provides command prompt-style graphics where one or more tile textures are used to represent an ASCII character set. Console's are made up of a grid of cells, each of which can have its own foreground, background, glyph, and special effect applied to it.

While SadConsole is a generic library that doesn't provide any rendering capabilities, "host" libraries are provided that add renderers to SadConsole. The two hosts provided by this library are for MonoGame and SFML.

SadConsole currently targets .NET 6 and .NET 7

For the latest changes in this release, see the notes below

Features

Here are some of the features SadConsole supports:

Show any number of consoles.
Uses graphical tile-based images to build out an ASCII-character font with support for more than 256 characters.
Use more than one font file. However, each console is restricted to a single font.
Independently controlled entities for game objects.
Keyboard and Mouse support.
Text UI control framework with windowing support.
Importers for DOS ANSI files, TheDraw text fonts, RexPaint, and Playscii.
Animated consoles.
Translating images to text-blocks.
Highly customizable framework.

String display and parsing

string pic

GUI library

GUI library pic

Scrolling

scrolling console

Dependencies

SadConsole uses NuGet for its .NET dependencies:

Newtonsoft.Json (>= 13.0.3)
TheSadRogue.Primitives (>= 1.6.0)

Example startup code

using SadConsole;
using SadConsole.Configuration;

Settings.WindowTitle = "SadConsole Examples";

Builder startup = new Builder()
    .SetScreenSize(90, 30)
    .OnStart(onStart)
    .IsStartingScreenFocused(true)
    .ConfigureFonts((config, game) => config.UseBuiltinFontExtended())
    ;

Game.Create(gameStartup);
Game.Instance.Run();
Game.Instance.Dispose();

void onStart()
{
    ColoredGlyph boxBorder = new ColoredGlyph(Color.White, Color.Black, 178);
    ColoredGlyph boxFill = new ColoredGlyph(Color.White, Color.Black);

    Game.Instance.StartingConsole.FillWithRandomGarbage(255);
    Game.Instance.StartingConsole.DrawBox(new Rectangle(2, 2, 26, 5), ShapeParameters.CreateFilled(boxBorder, boxFill));
    Game.Instance.StartingConsole.Print(4, 4, "Welcome to SadConsole!");
}

Latest changes v10.0.0 Beta 1 (10/09/2023)

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Newtonsoft.Json (>= 13.0.3)
- TheSadRogue.Primitives (>= 1.6.0-rc3)
net7.0
- Newtonsoft.Json (>= 13.0.3)
- TheSadRogue.Primitives (>= 1.6.0-rc3)

NuGet packages (8)

Showing the top 5 NuGet packages that depend on SadConsole:

Package	Downloads
SadConsole.Extended A library of common classes that extend SadConsole with new controls, windows, and more.	23.8K
SadConsole.Host.MonoGame A graphics hosting library for SadConsole that targets MonoGame.	20.2K
SadConsole.Host.SFML A graphics hosting library for SadConsole that targets SFML.	13.5K
SadConsole.GoRogueHelpers A helper library for SadConsole games built with GoRogue.	8.0K
TheSadRogue.Integration An official integration library for using GoRogue and SadConsole together to create a roguelike.	3.5K

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on SadConsole:

Repository	Stars
Thraka/SadConsole A .NET ascii/ansi console engine written in C# for MonoGame and XNA. Create your own text roguelike (or other) games!	1.3K

Version	Downloads	Last updated
10.5.0	345	12/7/2024
10.5.0-debug	101	12/7/2024
10.4.2	246	10/24/2024
10.4.2-debug	70	10/24/2024
10.4.1	1,247	6/13/2024
10.4.1-debug	151	6/13/2024
10.4.0	1,276	3/31/2024
10.4.0-debug	212	3/31/2024
10.0.3	486	3/14/2024
10.0.3-debug	259	3/14/2024
10.0.2	1,573	11/10/2023
10.0.2-debug	876	11/10/2023
10.0.1	753	11/10/2023
10.0.1-debug	721	11/10/2023
10.0.0	1,799	10/29/2023
10.0.0-debug	988	10/29/2023
10.0.0-beta3-debug	1,101	10/14/2023
10.0.0-beta3	1,067	10/14/2023
10.0.0-beta2-debug	1,050	10/11/2023
10.0.0-beta2	1,071	10/11/2023
10.0.0-beta1-debug	1,078	10/11/2023
10.0.0-beta1	1,117	10/11/2023
10.0.0-alpha4-debug	1,368	8/26/2023
10.0.0-alpha4	1,301	8/26/2023
10.0.0-alpha3-debug	1,212	8/26/2023
10.0.0-alpha3	1,229	8/26/2023
10.0.0-alpha2-debug	1,596	6/18/2023
10.0.0-alpha2	1,390	6/18/2023
10.0.0-alpha1-debug	1,492	6/4/2023
9.2.2	5,064	1/22/2022
9.2.2-debug	1,189	1/22/2022
9.2.1	2,447	1/4/2022
9.2.0	3,315	12/31/2021
9.2.0-debug	1,079	12/31/2021
9.1.1	5,399	8/7/2021
9.1.1-debug	1,270	8/7/2021
9.1.0	2,136	7/6/2021
9.1.0-debug	1,258	7/6/2021
9.0.0	4,632	6/6/2021
9.0.0-debug	1,259	6/6/2021
9.0.0-beta4	1,946	1/15/2021
9.0.0-beta3	2,054	12/19/2020
9.0.0-beta2	1,574	10/9/2020
9.0.0-beta1	1,695	8/1/2020
9.0.0-alpha9	1,706	7/25/2020
9.0.0-alpha8	1,396	7/13/2020
9.0.0-alpha7	1,734	7/11/2020
9.0.0-alpha6	1,767	5/28/2020
9.0.0-alpha5	1,562	5/26/2020
9.0.0-alpha4	1,408	5/1/2020
9.0.0-alpha3	1,604	5/1/2020
9.0.0-alpha2	1,497	3/14/2020
9.0.0-alpha1	1,921	1/26/2020
8.99.3	3,709	8/15/2020
8.99.3-debug	1,450	8/15/2020
8.99.2	1,779	7/14/2020
8.99.2-debug	1,410	7/14/2020
8.99.1	2,434	4/11/2020
8.99.1-debug	1,411	4/11/2020
8.99.0	2,473	11/27/2019
8.99.0-debug	1,407	11/27/2019
8.9.1	3,844	11/5/2019
8.9.1-debug	1,414	11/5/2019
8.9.0	2,180	9/7/2019
8.9.0-debug	1,599	9/7/2019
8.8.1	3,041	7/28/2019
8.8.1-debug	1,577	7/28/2019
8.8.0	2,358	7/27/2019
8.8.0-debug	1,517	7/27/2019
8.7.1	1,917	6/22/2019
8.7.1-debug	1,579	6/22/2019
8.7.0	1,764	6/22/2019
8.7.0-debug	1,598	6/22/2019
8.6.0	2,042	4/14/2019
8.6.0-debug	1,604	4/14/2019
8.5.0	1,937	4/2/2019
8.5.0-debug	1,630	4/2/2019
8.4.1	1,895	3/19/2019
8.4.1-debug	1,665	3/19/2019
8.4.0	1,756	3/17/2019
8.4.0-debug	1,598	3/17/2019
8.3.0	1,862	3/10/2019
8.3.0-debug	1,589	3/10/2019
8.2.0	1,900	3/2/2019
8.2.0-debug	1,671	3/2/2019
8.1.0	1,858	2/28/2019
8.1.0-debug	1,589	2/28/2019
8.0.0	1,958	2/24/2019
8.0.0-pre5	1,641	2/19/2019
8.0.0-pre4	1,672	1/31/2019
8.0.0-pre2	1,722	12/30/2018
8.0.0-pre1	1,689	12/30/2018
7.3.0	2,020	12/29/2018
7.2.0	2,112	11/20/2018
7.1.0	2,149	10/19/2018
7.0.4	2,096	9/8/2018
7.0.3	1,956	9/8/2018
7.0.2	2,312	8/31/2018
7.0.0	2,077	8/29/2018
7.0.0-pre1	1,780	8/22/2018
6.5.0	2,268	6/12/2018
6.4.11	2,313	4/13/2018
6.4.11-pre1	2,101	4/6/2018
6.4.10	2,269	3/18/2018
6.4.9	2,226	3/18/2018
6.4.8	2,193	3/18/2018
6.4.7	2,275	3/16/2018
6.4.6	2,474	2/14/2018
6.4.5	2,292	2/3/2018
6.4.3	2,272	11/14/2017
6.4.2	2,355	8/11/2017
6.4.1	2,178	8/10/2017
6.4.0	2,256	7/25/2017
6.3.0	2,275	6/9/2017
6.2.2	2,283	5/20/2017
6.2.1	2,394	4/23/2017
6.2.0	2,200	4/22/2017
6.1.4	2,197	4/17/2017
6.1.3	2,893	4/3/2017
6.1.2	2,165	4/1/2017
6.1.1	2,128	4/1/2017
6.1.0	2,149	3/31/2017
6.0.1	2,269	3/19/2017
6.0.0	2,073	3/18/2017

- OnStart startup config is no longer an Action but is now an event.
- Startup config changed again from the last alpha. Types were renamed and rewritten to be extensible. It works the same way as before except that everything is in the SadConsole.Configuration namespace. You must import that namespace to enable the extension methods that build the config. The type to build the config is Builder.
- Tabs orientated left/right didn't display the text properly.
- ColoredGlyph was renamed to ColoredGlyphBase and a new ColoredGlyph that inherits from the base class was added.
- Scrollbars didn't behave properly when in a CompositeControl.
- ListBox mouse logic was improved to use an "ItemsArea" property that designates when the mouse is over the items list specifically.
- StringParser supports variables. There's a dictionary that invokes a delegate which returns a value for the variable. So the value can be determined as the variable is used. See DemoStringParsing.cs in the sample template.
- AnimatedScreenObject's weren't rendering correctly.
- Decorators are no longer array's but rented from a list pool. Use the CellDecoratorHelpers class to manage them. SadConsole does its best to rent and return from the pool as you add or remove decorators.
- Default font used the wrong name. It's been corrected from "IBM_16x8" to "IBM_8x16".
- The ToggleSwitch control wasn't drawing properly.
- NumberBox supports cultured number parsing.
- CellDecorator, as a readonly struct, now declares the properties with "get; init;" which allows mutation with the the "with" keyword.
- EntityManager.AlternativeFont added to support different fonts for entities.