# Glitch3d

Glitch3d is an automated render library that uses glitching techniques applied to 3D meshes.

# TODO : add image
<!-- <img src="https://raw.githubusercontent.com/pskl/glitch3d/master/fixtures/demo.png" width="400"> -->

This gem uses the Blender Python API to produces renders headlessly.

## Warning

Setting `BLENDER_EXECUTABLE_PATH` in your environment is required.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'glitch3d'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install glitch3d

## Usage

- `glitch3d file.obj`

will
Options:
- `mode` : (localized|default|none) => glitching strategy
- `shots-number` : integer representing the number of - images desired (with animate: false)
- `quality` : (high: 2000 x 2000|low 200 x 200) default: low => size of the render
- `animate` : (true) default: false => Render .avi file
- `frame_numbers` : (default: 200) => number of frames

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pskl/glitch3d. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.


## License

Copyright © 217 PSKL <hello@pascal.cc>
This work is free. You can redistribute it and/or modify it under the
terms of the Do What The Fuck You Want To Public License, Version 2,
as published by Sam Hocevar. See the COPYING file for more details.