libansilove

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

README.md (2506B)


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