Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.93 KB

README.md

File metadata and controls

31 lines (17 loc) · 1.93 KB

libScricon: The Simple Graphical Console Library

Copyright (C) 2021-2022 Jyothiraditya Nellakra

Pronunciation & Etymology of the Name

Scricon is pronounced with the scr- of script and the icon of... well... the word icon; its representation in the international phonetic alphabet is /skɹaɪkən/.

I wanted to make the name a portmanteau of the description. Alas, Sgricon does not a valid sequence of sounds in English make. However, the graph- part of graphical comes from a greek word which could mean 'write', so I replaced it with the scr prefix from latin which is also related to writing, whence the c in scricon.

Example Output

The following is a screenshot of the output of the stars demo included with the library, in both monochrome and colour mode. This demo mainly makes use of LSC_buffer.h.

Stars screenshot.

The font used in the above image is Pacifico.

And the following is a demonstration of using the 16 available colours from the chaos demo. Notably, this demo doesn't set the background colours supported as part of ANSI, since it can seem quite messy even for abject chaos, but you can use them too, if you want.

Chaos screenshot.

Building & Running It

To compile the code, you can run make. This will produce a large number of programs as well as libScricon.a which you will need to link other programs with this library. If your goal is to compile your own code, make sure to include the include folder from the libScricon source tree in the include path for your program compilation.

If you wish to instead run the programs, you can run <program> --help to find the usage details of each of them individually.

When you're done, if you want to clean up after yourself, you can run make clean, which will automatically delete all programs, object files, and libScricon.a


Happy coding! :)