Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lastguest/pixeler

CLI image renderer
https://github.com/lastguest/pixeler

cli php pixel-art

Last synced: about 2 months ago
JSON representation

CLI image renderer

Awesome Lists containing this project

README

        

# Pixeler
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lastguest/pixeler?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Render images in CLI with UTF-8 characters.

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/lastguest/pixeler/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/lastguest/pixeler/?branch=master)
[![Total Downloads](https://poser.pugx.org/lastguest/pixeler/downloads.svg)](https://packagist.org/packages/lastguest/pixeler)
[![Latest Stable Version](https://poser.pugx.org/lastguest/pixeler/v/stable.svg)](https://packagist.org/packages/lastguest/pixeler)
[![Latest Unstable Version](https://poser.pugx.org/lastguest/pixeler/v/unstable.svg)](https://packagist.org/packages/lastguest/pixeler)
[![License](https://poser.pugx.org/lastguest/pixeler/license.svg)](https://packagist.org/packages/lastguest/pixeler)

## Installation

Require in your project with [composer](https://getcomposer.org/download/) :

```bash
$ composer require lastguest/pixeler
```

This will also install a **pixeler** tool in :

```
your_project_dir/vendor/bin/pixeler
```

It works exactly like the example below.

### Example

Create a file `pixel.php` :

```php
1, // Dithering mode : 0 = DITHER_NONE, 1 = DITHER_ERROR
'f' => false,
'r' => 1.0, // Resize factor 1.0 = 100%
'w' => 0.75, // Dither treshold weight
], getopt("f:r:w:d:ib"));

// An image file/url is required.
$opts['f'] || die("Must specify an image file.\n");

// The -i option inverts the image
$image = Pixeler\Pixeler::image($opts['f'], $opts['r'], isset($opts['i']), $opts['w'], $opts['d']);

// No colors if "-b" is passed
isset($opts['b']) && $image->clearColors();

// The Pixeler\Image instance render itself if casted to a string
echo $image;
```

```bash
$ php pixel.php -f http://drop.caffeina.co/image/160L0Y3C0a29/vocaloid.jpg -r .25 -w 0.25 -i
```

```bash
$ php pixel.php -f http://flippywall.com/wp-content/uploads/2014/07/Manga-Girl-Wallpaper-16.jpg -r 0.15 -w 0.5 -i
```

```bash
$ php pixel.php -f http://blog.circleci.com/wp-content/uploads/2014/07/elephant.jpg -r 0.3 -w 0.5 -b
```

### Dithering

Use the `-d` option to choose 1-bit dithering mode.

Command | Constant | Description
----|------|----
`-d0` | Pixeler\Image::DITHER_NONE | Threshold 1-bit quantization
`-d1` | Pixeler\Image::DITHER_ERROR | Dither image with 1-bit Atkinson Dithering

### Animation Example

You will see a lot of tearing, need some kind of vsync wait.

```php
height()/2;
$sh4 = $sh2/1.5;
$ph = pi()/32;
$i = 0;

// To exit, press Ctr-C
while(1){
$screen->clear();
for ($x=0,$c=$screen->width(); $x < $c; $x++){
$y = $sh4*sin($i++/128 + $ph*$x);
$screen->setPixel($x,$sh2 + $y);
$screen->setPixel($x,$sh2 + $y/2);
$screen->setPixel($x,$sh2 + $y/4);
$screen->setPixel($x,$sh2);
}
echo $screen;
}
```