SadConsole 9.2.2

.NET 5.0 .NET Core 3.1 .NET Standard 2.1
NuGet\Install-Package SadConsole -Version 9.2.2
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.
dotnet add package SadConsole --version 9.2.2
<PackageReference Include="SadConsole" Version="9.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SadConsole --version 9.2.2
#r "nuget: SadConsole, 9.2.2"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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=9.2.2

// Install SadConsole as a Cake Tool
#tool nuget:?package=SadConsole&version=9.2.2

SadConsole Logo

Chat on discord NuGet

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, .NET 5, .NET Core 3.1, and .NET Standard 2.1.

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.
  • Windowing capabilities.
  • Importers for DOS ANSI files, TheDraw text fonts, RexPaint, and Playscii.
  • Animation support.
  • Translating images to text-blocks.
  • Highly customizable system.
String display and parsing

string pic

GUI library

GUI library pic

Scrolling

scrolling console

Dependencies

SadConsole uses NuGet for its .NET dependencies:

Latest changes

v9.2.2 (01/22/2022)

(v9.2.2 Fix conversion of Mirror to SpriteEffects) (v9.2.1 Fix API documentation generation)

9.2.0

Breaking changes

  • [Breaking] Print(int x, int y, ColoredGlyph glyph) renamed to SetGlyph.
  • [Breaking] Surface SetEffect method signatures have changed.
  • [Breaking] Renamed Animation.ConvertImageFile to Animation.FromImage.
  • [Breaking] Removed ColorGradient as this type is implemented in the SadRogue.Primitives library as Gradient.

Behavioral changes

  • [Behavior] ColoredString.String.Set forced the string through the parser. This has now changed to use the characters directly.
  • [Behavior] All ColoredString contructors that used the (string) overload used the string parser. This is no longer the case.
  • [Behavior] ColoredString.IgnoreEffect no longer defaults to true.
  • [Behavior] Using Surface.Print methods that used the string parser for fore/back/mirror will force those settings after the string was parsed and not before.
  • [Behavior] Surface Clear and Fill methods now clear the effect.
  • [Behavior] Print statements have been updated to all act the same.
    • New overload added that accepts decorators.
    • Print clears the effect over the glyphs printed.
    • Print that uses the string processor now processes the string and then sets the appropriate overloaded settings. For example, the overload that sets the foreground and background colors will process the string and then set the foreground and background of the entire string. This is a change from previous behavior which set the colors at the start of the string processor and allowed the processor to override the overload.

Host changes

  • [MonoGame] Added DrawCallManager to allow injecting custom sprite batch rendering during final scene composition.
  • [MonoGame/SFML] Fixed a bug that caused all surfaces to redraw all cells 100% of the time even if nothing changed. Should bring 300%-400% fps increase in surfaces that aren't changing content.
  • [MonoGame/SFML] ITexture improvements for GetPixel/SetPixel; Demos on editing textures. (RychuP)
  • [MonoGame/SFML] The game host now has a FrameNumber property that increments each frame cycle.
  • [SFML] Fixed Settings.UnlimitedFPS. This now works.

Other changes

  • [Core] Fixed bug that caused redraws every frame even if nothing had changed.
  • [Core] Cursor didn't respect Cursor.UseStringParser because of how ColoredString was always using the string parser. This is fixed now.
  • [Core] Cursor has a Cursor.MouseClickRepositionHandlesMouse property which sets the handled flag on mouse left-click for the cursor reposition.
  • [Core] Cursor updates the space character appearance while printing. Previously only the first character was used to determine the space's appearance.
  • [Core] DrawString instruction overrides reset now, fixing a bug with having the instruction run more than once.
  • [Core] Surface.ShiftLeft|Right|Up\Down methods now move decorators.
  • [Core] New Surface.ShiftRow and Surface.ShiftColumn methods added. (Chris3606)
  • [Core] ColoredString.SetDecorators added, to fit in with SetForeground, SetBackground, etc.
  • [Core] Renamed EffectsChain to EffectSet and added new CodeEffect type.
  • [Core] Effects use TimeSpan instead of double.
  • [Core] The EffectsManager used by a surface now works on cell instances, not cell indices.
  • [Core] Resizing a surface without the clear parameter keeps existing effects instead of dropping them.
  • [Core] AnimatedSurface.FromImage helper added which converts image-based animations to an animated surface. (RychuP)
  • [Core] Added TheDraw font reader: SadConsole.Readers.TheDrawFont. Not a SadConsole Font.
  • [Core] Playscii support added in the SadConsoles.Readers namespace. (RychuP)
  • [Core] Entity renderer has a RemoveAll method to clear out all the entities.
  • [Core] Entity renderer now has a SkipExistsChecks property which can greatly improve performance when adding/removing entities (when you already have a lot of entities).
  • [Core] For entities, added AnimatedAppearanceComponent which can be added to an entity to animate the glyph like the AnimatedSurface did for the old entity type.
  • [UI] Fix various minor bugs with controls.
  • [UI] Textbox has more events related to text changing.
  • [UI] Textbox behaviors have changed slightly. For example, EditingText event doesn't fire when the text ends up being the same before editing.
  • [UI] ListBox items can be inserted as a ValueTuple<string, object> which will use the string (can be a ColoredString) as the display text of the item.
  • [StringParser] Introduced new interface for string parsing: StringParser.IParser.
  • [StringParser] Moved current parse code to StringParser.Default.
  • [StringParser] ColoredString.Parse is obsolete and forwards to ColoredString.Parser.Parse.
  • [StringParser] String processor now has a decorators command: [c:d glyph:mirror:color[:count]]
  • [StringParser] String processor no longer hides effects until they're used. All processed strings will set a null effect that will be set on the cells that are printed.
  • [ExtendedLib] Added ClassicConsoleKeyboardHandler and C64KeyboardHandler for cursor handlers.
  • [ExtendedLib] Added MoveViewPortKeyboardHandler component.
  • [ExtendedLib] Added surface.PrintFadingText extension method that prints text using the DrawString instruction with an effect.
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on SadConsole:

Package Downloads
SadConsole.Host.MonoGame

A graphics hosting library for SadConsole. Targets MonoGame and .NET Standard 2.1.

SadConsole.Host.SFML

A graphics hosting library for SadConsole. Targets SFML and .NET Standard 2.1.

SadConsole.Extended

A library of common classes that extend SadConsole with new controls, windows, and more.

SadConsole.GoRogueHelpers

A helper library for SadConsole games built with GoRogue.

TheSadRogue.Integration

An official integration library for using GoRogue and SadConsole together to create a roguelike.

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!
Version Downloads Last updated
9.2.2 1,000 1/22/2022
9.2.2-debug 79 1/22/2022
9.2.1 361 1/4/2022
9.2.0 589 12/31/2021
9.2.0-debug 68 12/31/2021
9.1.1 1,561 8/7/2021
9.1.1-debug 186 8/7/2021
9.1.0 591 7/6/2021
9.1.0-debug 156 7/6/2021
9.0.0 1,080 6/6/2021
9.0.0-debug 160 6/6/2021
9.0.0-beta4 331 1/15/2021
9.0.0-beta3 372 12/19/2020
9.0.0-beta2 318 10/9/2020
9.0.0-beta1 405 8/1/2020
9.0.0-alpha9 454 7/25/2020
9.0.0-alpha8 269 7/13/2020
9.0.0-alpha7 383 7/11/2020
9.0.0-alpha6 465 5/28/2020
9.0.0-alpha5 355 5/26/2020
9.0.0-alpha4 307 5/1/2020
9.0.0-alpha3 357 5/1/2020
9.0.0-alpha2 319 3/14/2020
9.0.0-alpha1 591 1/26/2020
8.99.3 2,265 8/15/2020
8.99.3-debug 279 8/15/2020
8.99.2 485 7/14/2020
8.99.2-debug 260 7/14/2020
8.99.1 1,093 4/11/2020
8.99.1-debug 318 4/11/2020
8.99.0 1,066 11/27/2019
8.99.0-debug 313 11/27/2019
8.9.1 825 11/5/2019
8.9.1-debug 300 11/5/2019
8.9.0 868 9/7/2019
8.9.0-debug 434 9/7/2019
8.8.1 806 7/28/2019
8.8.1-debug 443 7/28/2019
8.8.0 544 7/27/2019
8.8.0-debug 426 7/27/2019
8.7.1 664 6/22/2019
8.7.1-debug 444 6/22/2019
8.7.0 513 6/22/2019
8.7.0-debug 453 6/22/2019
8.6.0 802 4/14/2019
8.6.0-debug 470 4/14/2019
8.5.0 670 4/2/2019
8.5.0-debug 514 4/2/2019
8.4.1 639 3/19/2019
8.4.1-debug 482 3/19/2019
8.4.0 555 3/17/2019
8.4.0-debug 469 3/17/2019
8.3.0 597 3/10/2019
8.3.0-debug 478 3/10/2019
8.2.0 616 3/2/2019
8.2.0-debug 511 3/2/2019
8.1.0 593 2/28/2019
8.1.0-debug 480 2/28/2019
8.0.0 658 2/24/2019
8.0.0-pre5 560 2/19/2019
8.0.0-pre4 546 1/31/2019
8.0.0-pre2 582 12/30/2018
8.0.0-pre1 537 12/30/2018
7.3.0 679 12/29/2018
7.2.0 817 11/20/2018
7.1.0 841 10/19/2018
7.0.4 819 9/8/2018
7.0.3 707 9/8/2018
7.0.2 1,003 8/31/2018
7.0.0 756 8/29/2018
7.0.0-pre1 635 8/22/2018
6.5.0 941 6/12/2018
6.4.11 1,037 4/13/2018
6.4.11-pre1 935 4/6/2018
6.4.10 933 3/18/2018
6.4.9 877 3/18/2018
6.4.8 879 3/18/2018
6.4.7 903 3/16/2018
6.4.6 1,111 2/14/2018
6.4.5 951 2/3/2018
6.4.3 948 11/14/2017
6.4.2 1,019 8/11/2017
6.4.1 847 8/10/2017
6.4.0 912 7/25/2017
6.3.0 968 6/9/2017
6.2.2 918 5/20/2017
6.2.1 1,028 4/23/2017
6.2.0 878 4/22/2017
6.1.4 899 4/17/2017
6.1.3 1,541 4/3/2017
6.1.2 863 4/1/2017
6.1.1 873 4/1/2017
6.1.0 853 3/31/2017
6.0.1 940 3/19/2017
6.0.0 839 3/18/2017

9.2.0 contains lots of changes, including breaking changes. See NuGet or GitHub documentation for more information. 9.2.1 only fixes API documentation. 9.2.2 hardcodes the mirror enum values.