three-noise

THREE-Noise

Simple gradient noise library for use with Three.js. Now with fBm!
View Demo · Report Bug · API Docs

Installation

Make sure to have ThreeJS installed.

$ npm i three

Install through NPM

$ npm i three-noise

For Browsers, download build/three-noise.js.

Importing

Browser

In your HTML

<script src="lib/three-noise.js"></script>
<script src="./main.js" defer></script>

Then, in your JavaScript you can use the THREE_Noise object.

const { Perlin, FBM } = THREE_Noise;

NodeJS

In NodeJS, you can import it like you normally do.

import { Perlin, FBM } from 'THREE_Noise';

Usage

Perlin

// Instantiate the class with a seed
const perlin = new Perlin(Math.random())

perlin.get2(vector2)   // Get 2D Perlin Nosie
perlin.get3(vector3)   // Get 3D Perlin Nosie

fBm

// Instantiate the class with a seed
const fbm = new FBM({
    seed: Math.random()
})

fbm.get(vector2)      // Get 2D Perlin Nosie with fBm
fbm.get(vector3)      // Get 3D Perlin Nosie with fBm