libansilove

Library for converting ANSI, ASCII, and other formats to PNG
Log | Files | Refs | README | LICENSE

README.md (2900B)


      1 # libansilove
      2 
      3 libansilove is a library to convert ANSi and artscene related file formats
      4 into PNG images.
      5 
      6 # Dependencies
      7 
      8 libansilove uses the `CMake` build system and requires the `GD` library and
      9 header files.
     10 
     11 # Installing dependencies
     12 
     13 - OpenBSD: `pkg_add -r cmake gd`
     14 - NetBSD: `pkgin install cmake gd`
     15 - FreeBSD: `pkg install cmake gd`
     16 - macOS: `brew install cmake gd`
     17 - Alpine Linux: `apk add cmake gcc make musl-dev gd-dev`
     18 - Debian / Ubuntu / Mint: `apt-get install build-essential cmake libgd-dev`
     19 - Fedora: `dnf install cmake gcc make gd-devel`
     20 - Solus: `eopkg install -c system.devel` and `eopkg install gd-devel`
     21 
     22 # Compiling
     23 
     24 	mkdir build
     25 	cd build
     26 	cmake ..
     27 	make
     28 
     29 # Installation
     30 
     31 	make install
     32 
     33 # Packages
     34 
     35 Packages are available for the following operating systems:
     36 
     37 - [OpenBSD][1]
     38 - [NetBSD][2]
     39 - [FreeBSD][3]
     40 - [Debian][4]
     41 - [Ubuntu][5]
     42 - [openSUSE][6]
     43 - [Solus][7]
     44 - [Gentoo][8]
     45 
     46 # Features
     47 
     48 The following formats are supported:
     49 
     50 - .ANS - ANSi (ANSI escape sequences: ANSI X3.64 standard)
     51 - .PCB - PCBoard Bulletin Board System (BBS) own file format
     52 - .BIN - Binary format (raw memory copy of text mode video memory)
     53 - .ADF - Artworx format, supporting custom character sets and palettes
     54 - .IDF - iCE Draw format, supporting custom character sets and palettes
     55 - .TND - TundraDraw format, supporting 24-bit color mode
     56 - .XB - The eXtended Binary XBin format, supporting custom character sets and palettes
     57 
     58 # Documentation
     59 
     60 # Usage
     61 
     62 See the `example` directory for an example showing how to use the library to
     63 convert a file to PNG.
     64 
     65 # Projects using libansilove
     66 
     67 - [Ansilove][9] - ASCII / ANSI art to PNG converter, also supporting several artscene file formats
     68 - [ANSi View (PS3)][10] - ANSi and artscene related file formats viewer for the PlayStation 3
     69 
     70 # Bindings
     71 
     72 Bindings for other programming languages:
     73 
     74 - [Racket][11]
     75 
     76 # License
     77 
     78 libansilove is released under the BSD 2-Clause license. See the file `LICENSE` for details.
     79 
     80 # Authors
     81 
     82 libansilove is developed by Stefan Vogt ([@ByteProject][12]), Brian Cassidy
     83 ([@bricas][13]) and Frederic Cambus ([@fcambus][14]).
     84 
     85 # Resources
     86 
     87 Project homepage: https://www.ansilove.org
     88 
     89 GitHub: https://github.com/ansilove/libansilove
     90 
     91 [1]: https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/graphics/libansilove
     92 [2]: https://pkgsrc.se/graphics/libansilove
     93 [3]: https://www.freshports.org/graphics/libansilove/
     94 [4]: https://packages.debian.org/search?keywords=libansilove
     95 [5]: https://packages.ubuntu.com/search?keywords=libansilove
     96 [6]: https://software.opensuse.org/package/libansilove
     97 [7]: https://dev.getsol.us/source/libansilove/
     98 [8]: https://packages.gentoo.org/packages/dev-libs/libansilove
     99 [9]: https://github.com/ansilove/ansilove
    100 [10]: https://github.com/bucanero/ansiview-ps3
    101 [11]: https://gitlab.com/xgqt/racket-libansilove
    102 [12]: https://github.com/ByteProject
    103 [13]: https://github.com/bricas
    104 [14]: https://github.com/fcambus