StarASCII

🧩 ➥ Library for creating ASCII animations for terminals.

Installation

The latest version is available on NuGet. To install, run:

dotnet add package StarASCII --version *

Replace the asterisk (*) with the desired version.

Alternatively, clone the repository and reference it manually:

git clone https://github.com/Starciad/StarASCII.git

After installation, add the StarASCII namespace:

using StarASCII;

You can now use the SAnimation class to create and run animations:

SAnimation anim = new SAnimation();

Next, add frames using the AddFrame(SFrame) method:

SFrame frame = new SFrame(string, uint);
anim.AddFrame(frame);

Once all frames are added, run the animation:

anim.Play();

[!IMPORTANT] When calling Play(), the main thread will be paused according to the frame durations.

Explore the classes and features to fully customize your animations.

Frame size: Keep all frames the same size to avoid visual issues.
Using text files: For complex animations, save frames in external text files or use const or readonly static properties to avoid hardcoded ASCII art.
Reuse animations: To save resources, reuse animations by storing them in collections, lists, or static properties, especially in performance-critical scenarios like loops.