datamosh-js / datamosh Goto Github PK

View Code? Open in Web Editor NEW

43.0 1.0 6.0 251 KB

✨💾 Edit images via buffers. 💯✨

License: MIT License

JavaScript 100.00%

nodejs buffer image datamoshing cat manipulate-images datamosh callback

datamosh's Introduction

Datamosh

Mess around with image data using buffers, create some interesting & artistic results, profit.

Install

$ npm install datamosh

Usage

const mosh = require("datamosh");

let imgBuff = await readFile("/full/path/to/image.png");

let moshedBuff = await mosh(imgBuff, "vaporwave");

Reading/Writing the moshed image

mosh("~/image.png", null, "~/moshed_image.png");

// because mode is null, a random mode will be chosen

Moshing a buffer with callbacks

const cb = (err, data) => {
  if (!err) writeFile("/path/to/out.gif", data);
};

mosh(imgBuff, "vana", cb);

Using multiple modes on a single image, applied with respect to order.

let moshedBuff = await mosh(imgBuff, ["fatcat", "vaporwave", "walter"]);

// ['vana', null, null] is also valid => ['vana', random, random]

API

`mosh(source, mode?, cb|writePath?)`

Takes input source Buffer/Path, returns an encoded Buffer with the applied modes.

mode, the mosh mode to apply to the source image. Multiple modes may be passed using an array of modes. Any null values are replaced with a random mode.
cb (err, data), when using callbacks.
writePath, the path to write the moshed image to.

Paths may use the tilde (~) character. Datamosh validates read and write paths, replacing tilde with the path to the home directory.

~/Desktop/moshes/ -> /home/youruser/Desktop/moshes

Custom Modes

Datamosh allows you to set custom moshing modes. As of v1.1.0, this may be acomplished by adding a mosh function to the MODES property.

For mosh function starter code, see the included template file located here.

const datamosh = require("datamosh");

function newMode(data, width, height) {
  // your cool code goes here!

  return data;
}

datamosh.MODES.newMode = newMode;

Example Images

Fatcat was created by user @mster

Vaporwave was created by user @tlaskey

Datamosh in the wild

Check out this list of awesome apps that use datamosh!

JanMichaelBot by user @Tlaskey

datamosh's People

Contributors

Stargazers

Watchers

Forkers

enmanuelmag tlaskey michaelpaulukonis bjrint sixem kabanfriends

datamosh's Issues

Repeat short syntax

From @tlaskey

Suggestion, let us do. !m fatcat 5 vaporwave 2 walter 3

Docs: Contributing add Moshbench-cli reference

Feature: Seeds

Use seeds for randoms if provided -- will need to consider new mode param synthax?

Feat: Lazy load modes

Lazy load modes instead of importing each.

As proposed by @tlaskey

Introduction:

It would be nice to support the Windows OS, haha.

Details:

Support Window's style pathing i.e. C:\Users\YOURUSERNAME\Desktop

Work:

Change validation functions to either check os or replace \ with /

Bug: Veneneux mode breaks premoshed images

ISSUE:
Given an image that has already been moshed, running veneneux mode results in a corrupted image which in not viewable.

PROPOSED FIX:
Limit veneneux randomness assignment to a maximum 255.

Want to work with buffers to create some fun images?

Consider adding a mode to Datamosh!

Work

By adding a new mode, you will be creating a new file which exports a function that manipulates data extracted from a source image's bitmap. That may sound like a lot, but it'll essentially come down to basic iteration over a buffer. Starter code has been provided here.

Your mosh mode doesn't have to do anything specific -- if you think it's cool, we probably will too. Use your imagination and feel free to experiment!

Most of Datamosh's current modes overwrite existing Red/Green/Blue (RGB) pixel values with something random. If you get stuck check out some examples.

To test your mode, you have two options:

(Preferred) Import it into Datamosh by adding an entery in mosh.MODES, here.
Add it to the function property after you initialize Datamosh. Example code on how to do this can be found here.

On Contributing

There aren't many hoops to jump though.

Datamosh uses Prettier for linting and formatting. You will be approved for merging as long as your code passes npm test and only modifies what is needed for your contribution.

You can learn more about contributing in our Contributing document.

Contributing

tack on to next release