# noise-library

> A collection of noise functions

Latest version **1.0.1** (published 2018-09-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install noise-library
pnpm add noise-library
yarn add noise-library
bun add noise-library
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2018-09-27 |
| First published | 2018-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | William Siuhang |
| Maintainers | williamsiuhang |
| Keywords | javascript, webgl, three.js, noise, library, perlin, perlin2, perlin3, seed, simplex, simplex2, simplex3 |

## Links

- npm: https://www.npmjs.com/package/noise-library
- npm.io page: https://npm.io/package/noise-library

## Recent versions

- 1.0.1 (latest) — 2018-09-27
- 1.0.0 — 2018-09-27

## README

# Javascript Noise Library
> A speed-improved perlin and simplex noise algorithms for 2D.
Based on example code by Stefan Gustavson (stegu@itn.liu.se).
Optimisations by Peter Eastman (peastman@drizzle.stanford.edu).
Better rank ordering method by Stefan Gustavson in 2012.
Converted to Javascript by Joseph Gentle.
Version 2012-03-09
This code was placed in the public domain by its original author, Stefan Gustavson.
Version 2018-09-27
Converted into NPM module by William Siuhang (williamsiuhang@gmail.com)

# Installation
Install by running `npm install noise-library` in terminal

# Usage
Importing library for use `import Noise from 'noise-library';`

##### Example
```javascript
import Noise from 'noise-library';

var perlinValue2d = Noise.perlin2(x, y);
var perlinValue3d = Noise.perlin3(x, y, z);

// where x, y, z are the normalized coordinates of a WebGL object vertice
```

Library includes Perlin, Simplex and Seed noise

---
_Source: https://npm.io/package/noise-library · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._