Skip to content

A C# .NET library for printing to the console with style!

License

Notifications You must be signed in to change notification settings

lewisdoesstuff/FancyPrint

Repository files navigation

FancyPrint

Build

A C# .NET Library for printing to the console with style!

Description

FancyPrint is a simple .NET library used to print information to the console with preset formatting and color templates. This should be a fairly drop-in replacement for Console.WriteLine statements, you'll just need to add a 'Method' to them.

The library contains 4 methods:

  • WriteStandard writes the text in white (or the default console foreground color)
  • WriteError writes the text in red
  • WriteWarn writes the text in yellow
  • WriteSuccess writes the text in green.

All colors are configurable though FancyPrint.Colors

Getting Started

Dependencies

  • Project targets .NET 5.0.
  • The .NET Runtime is required for running console applications.

Building

  • Building the library from scratch just requires you to download the solution, then build this through your .NET IDE of choice
  • You can also use dotnet build from the CLI to build the file.

Installing

  • Add reference to FancyPrint.dll in your .NET Project.
  • You can also add the FancyPrint NuGet package from the CLI or your IDE.

Usage

C# Example

        static void Main(string[] args)
        {
            // 1st parameter: Method to be printed inside []
            // 2nd parameter: Message to be displayed.
            FancyPrint.Print.WriteSuccess("Docs", "This worked!");
            FancyPrint.Print.WriteWarn("Docs", "This kinda worked!");
            FancyPrint.Print.WriteError("Docs", "This didn't work!");
            FancyPrint.Print.WriteStandard("Docs", "This is some information.");
           
            // Change method, success, warning, and error colors to anything you wish! 
            FancyPrint.Colors.Method = ConsoleColor.Magenta;
            Console.WriteLine();
            FancyPrint.Print.WriteSuccess("Docs", "Now in purple!");
            
            FancyPrint.Colors.Success = ConsoleColor.Cyan;
            Console.WriteLine();
            FancyPrint.Print.WriteSuccess("Docs", "No Added Sugar!");
            Console.WriteLine();
            
            // Print only text by passing an empty string as the method
            FancyPrint.Print.WriteWarn("","Just the text!");
            Console.ReadLine();
        }

image

Authors

lewisdoesstuff

Version History

  • 0.1.2

    • Passing an empty string as method doesn't display "[]"
  • 0.1.1

    • Added color option to PrintStandard()
  • 0.1

    • Initial Release

License

This project is licensed under the MIT License - see the LICENSE.md file for details