https://github.com/ucnv/pnglitch

A Ruby library to glitch PNG images.
https://github.com/ucnv/pnglitch

Last synced: 18 days ago
JSON representation

A Ruby library to glitch PNG images.

• Host: GitHub
• URL: https://github.com/ucnv/pnglitch
• Owner: ucnv
• License: mit
• Created: 2014-11-05T02:32:23.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-09-10T10:42:42.000Z (about 1 year ago)
• Last Synced: 2024-08-01T01:28:00.104Z (3 months ago)
• Language: Ruby
• Size: 206 MB
• Stars: 456
• Watchers: 15
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# PNGlitch

[![Gem Version](https://badge.fury.io/rb/pnglitch.svg)](https://badge.fury.io/rb/pnglitch)

[![test](https://github.com/ucnv/pnglitch/actions/workflows/ruby.yml/badge.svg)](https://github.com/ucnv/pnglitch/actions/workflows/ruby.yml)

PNGlitch is a Ruby library to destroy your PNG images.

With normal data-bending technique, a glitch against PNG will easily fail

because of the checksum function. We provide a fail-proof destruction for it.

Using this library you will see beautiful and various PNG artifacts.

For more details about glitching PNG image, see

[my documentation _The Art of PNG Glitch_](http://ucnv.github.io/pnglitch/).

## Usage

```ruby

  require 'pnglitch'

  PNGlitch.open('/path/to/your/image.png') do |p|

    p.glitch do |data|

      data.gsub /\d/, 'x'

    end

    p.save '/path/to/broken/image.png'

  end

```

_The Art of PNG Glitch_ includes [the usage of this library](http://ucnv.github.io/pnglitch/#appendix-a).

### CLI

Once you've installed the gem, it can be used in the terminal.

```sh

Usage:

  pnglitch  [--filter=] 

Options:

  -f, --filter=  Fix all filter types as passed value before glitching.

                    A number (0..4) or a type name (none|sub|up|average|paeth).

  --version         Show version.

  -h, --help        Show this screen.

  ```

## Installation

Add this line to your application's Gemfile:

    gem 'pnglitch'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install pnglitch

## Contributing

1. Fork it ( http://github.com/ucnv/pnglitch/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request