https://github.com/vanruesc/noise

A 2D noise texture generator that implements bilinear smoothing and turbulence.
https://github.com/vanruesc/noise

Last synced: 8 months ago
JSON representation

A 2D noise texture generator that implements bilinear smoothing and turbulence.

• Host: GitHub
• URL: https://github.com/vanruesc/noise
• Owner: vanruesc
• License: zlib
• Archived: true
• Created: 2015-10-26T15:09:12.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-06T20:46:42.000Z (over 10 years ago)
• Last Synced: 2025-01-08T09:46:18.411Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 348 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Noise

[![Build status](https://travis-ci.org/vanruesc/noise.svg?branch=master)](https://travis-ci.org/vanruesc/noise) 

[![Windows build status](https://ci.appveyor.com/api/projects/status/1vnesrjt9xcvs9y2?svg=true)](https://ci.appveyor.com/project/vanruesc/noise) 

[![GitHub version](https://badge.fury.io/gh/vanruesc%2Fnoise.svg)](http://badge.fury.io/gh/vanruesc%2Fnoise) 

[![npm version](https://badge.fury.io/js/%40vanruesc%2Fnoise.svg)](http://badge.fury.io/js/%40vanruesc%2Fnoise) 

[![Dependencies](https://david-dm.org/vanruesc/noise.svg?branch=master)](https://david-dm.org/vanruesc/noise)

A 2D noise texture generator that implements bilinear smoothing and turbulence.

## Installation

This module can be installed from [npm](https://www.npmjs.com).

```sh

$ npm install @vanruesc/noise

``` 

## Usage

```javascript

import Noise from "@vanruesc/noise";

var noise = new Noise(800, 600);

var data = noise.generate();

```

```sh

# CLI when used in an npm script.

noise -w 1920 -h 1080 -p 0 -o myTexture

# The generated file will be stored in the output folder.

```

```sh

  Optional arguments:

    -w      Width, Number.

    -h      Height, Number.

    -p      Pattern, Number (0, 1, 2).

    -a      Turbulence power, Number.

    -b      Turbulence size, Number.

    -c      Repetition x, Number.

    -d      Repetition y, Number.

    -n, -o  Name of the output file, String.

```

## Examples

![Clouds](http://vanruesc.github.io/noise/output/clouds.jpg)

![Marble](http://vanruesc.github.io/noise/output/marble.jpg)

![Wood](http://vanruesc.github.io/noise/output/wood.jpg)

## Documentation

[API](http://vanruesc.github.io/noise/docs)

## License

Copyright (c) 2015 Raoul van Rüschen  

Licensed under the Zlib license.