# noisejs

> Perlin noise implementation

Latest version **2.1.0** (published 2013-11-07) · 0 weekly downloads

## Install

```sh
npm install noisejs
pnpm add noisejs
yarn add noisejs
bun add noisejs
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2013-11-07 |
| First published | 2013-11-06 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/noisejs) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 37 |
| Author | Joseph Gentle |
| Maintainers | xixixao |
| Keywords | perlin, noise, simplex |

## Links

- npm: https://www.npmjs.com/package/noisejs
- Repository: https://github.com/xixixao/noisejs
- Issues: https://github.com/josephg/noisejs/issues
- npm.io page: https://npm.io/package/noisejs

## Recent versions

- 2.1.0 (latest) — 2013-11-07
- 2.0.0 — 2013-11-06

## README

# NOISE!

This is a simple library for 2d & 3d perlin noise and simplex noise in javascript. Noise is [pretty](https://dl.dropbox.com/u/2494815/perlin/index.html).

The library is pretty fast (10M queries / sec). But its still way slower than using a shader. For example, if you try and update an entire screen's worth of pixels, it'll be [slow](http://josephg.github.com/noisejs/demo3d.html).

The code is based on Stefan Gustavson's implementation. Do whatever you want with it, etc.

## How to make noise:

```javascript
// value passed into the constructor is used as a seed
var noise = new Noise(Math.random());

for (var x = 0; x < canvas.width; x++) {
  for (var y = 0; y < canvas.height; y++) {
    // noise.simplex2 and noise.perlin2 return values between -1 and 1.
    var value = noise.simplex2(x / 100, y / 100);

    image[x][y].r = Math.abs(value) * 256; // Or whatever. Open demo.html to see it used with canvas.
  }
}
```

The library exposes a constructor function called `Noise` with the following instance methods:

- **simplex2(x, y)**: 2D Simplex noise function
- **simplex3(x, y, z)**: 3D Simplex noise function
- **perlin2(x, y)**: 2D Perlin noise function
- **perlin3(x, y, z)**: 3D Perlin noise function
- **seed(val)**: Seed the noise functions. Only 65536 different seeds are supported. Use a float between 0 and 1 or an integer from 1 to 65536.

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