ConsoleRenderer 0.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ConsoleRenderer --version 0.1.0
NuGet\Install-Package ConsoleRenderer -Version 0.1.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="ConsoleRenderer" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ConsoleRenderer --version 0.1.0
#r "nuget: ConsoleRenderer, 0.1.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.
// Install ConsoleRenderer as a Cake Addin
#addin nuget:?package=ConsoleRenderer&version=0.1.0

// Install ConsoleRenderer as a Cake Tool
#tool nuget:?package=ConsoleRenderer&version=0.1.0

What is ConsoleRenderer

This is a simple and easy-to-use library to help render images to the console that works on Windows or Linux. This allows a developer to easily build retro looking applications using C# and .NET.

I learned programming with QBasic on MS-DOS and miss the days where you can get graphics on screen with just a few lines of code, ConsoleRenderer is a bit of an homage to that minimal style of development. Modern graphics libraries tend to have a lot of ceremony to set up a render window and get things on screen, this library aims to be the opposite of that.

What's the performance like?

It varies, but on my Lenovo P51 laptop the pong example runs at ~800fps on Windows in a 120x30 size Powershell terminal inside Windows Terminal. The same size WSL terminal on Ubuntu runs at ~3600fps, which is considerably faster. Updating every character on screen every frame is a lot slower, and can be as low as 10fps on Windows, or ~50fps on Ubuntu in WSL.

I welcome more rigorous benchmarks, as well as suggestions to improve performance, but the bottom line is that it's fast enough for anything that doesn't redraw the whole screen every frame.

Why is it on GitHub

It's on GitHub because I enjoy little projects like this, and because I believe in sharing what you enjoy with others, who may also enjoy it.

What is the future of this project

Right now it's a fun little thing that I made. Maybe I will end up using it in other projects and need additional functionality, maybe other people want to use it in theirs, who knows?

How to build and run it

Simply open the solution in Visual Studio and hit run to get a simple console window with a blue bouncing ball. The sample project is just a basic example of how it may be used.

For other IDE's, be sure to have the .NET 6 SDK installed and any relevant plugins for C#. There should be no dependencies other than what is in the System namespaces.

Contributing

If there are changes you'd like to see, feel free to create an issue or a PR.

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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.

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
0.7.0 196 1/4/2024
0.6.1 142 12/14/2023
0.6.0 97 12/14/2023
0.5.0 112 12/13/2023
0.4.3 121 12/11/2023
0.4.2 139 10/4/2023
0.4.1 116 10/4/2023
0.4.0 124 9/24/2023
0.3.0 173 7/6/2023
0.2.0 141 6/30/2023
0.1.0 143 6/15/2023