Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 4.41 KB

README.md

File metadata and controls

142 lines (87 loc) · 4.41 KB
Raw

Node.js Simplex

CI codecov Latest Stable Version Total Downloads License

Maintained fork of fast-simplex-noise that works in TS environments.

Originally forked from unmaintained joshforisha/fast-simplex-noise-js.

🤝 Supporting

Renoki Games. is a Renoki Co. subsidiary, made with ❤. Consider reaching out and supporting Renoki Co..

🚀 Installation

You can install the package via npm:

npm install @renoki-games/node-simplex

🙌 Usage

import { Simplex } from '@renoki-games/node-simplex';

const noiser = new Simplex({
    frequency: 0.01,
    max: 255,
    min: 0,
    octaves: 8,
});

let grid = [];

for (let x = 0; x < 1024; x++) {
    for (let y = 0; y < 768; y++) {
        grid.push({
            x,
            y,
            noise: noiser.scaled([x, y]),
        });
    }
}

API

Constructor

FastSimplexNoise(options?: Options = {})

Options contains:

  • amplitude: number – The base amplitude (default: 1.0)
  • frequency: number – The base frequency (default: 1.0)
  • max: number – The maximum scaled value to return (effective default: 1.0)
  • min: number – The minimum scaled value to return (effective default: -1.0)
  • octaves: number – Integer; the number of octaves to sum for noise generation (default: 1)
  • persistence: number – The persistence of amplitude per octave (default: 0.5)
  • random: () => number – A function that generates random values between 0 and 1 (default: Math.random)

Instance Methods

cylindrical(circumference: number, coords: number[]): number

Get a scaled noise value (using options) for a 2D or 3D point at coords on the surface of a cylinder with circumference.

cylindrical2D(circumference: number, x: number, y: number): number

Specific cylindrical() call for a 2D point at (x, y).

cylindrical3D(circumference: number, x: number, y: number, z: number): number

Specific cylindrical() call for a 3D point at (x, y, z).

raw(coords: number[]): number

Get a noise value [-1, 1] at a 2D, 3D, or 4D point at coords.

raw2D(x: number, y: number): number

Specific raw() call for a 2D point at (x, y).

raw3D(x: number, y: number, z: number): number

Specific raw() call for a 3D point at (x, y, z).

raw4D(x: number, y: number, z: number, w: number): number

Specific raw() call for a 4D point at (x, y, z, w).

scaled(coords: number[]): number

Get a scaled noise value (using options) at a 2D, 3D, or 4D point at coords.

scaled2D(x: number, y: number): number

Specific scaled() call for a 2D point at (x, y).

scaled3D(x: number, y: number, z: number): number

Specific scaled() call for a 3D point at (x, y, z).

scaled4D(x: number, y: number, z: number, w: number): number

Specific scaled() call for a 4D point at (x, y, z, w).

spherical(circumference: number, point: number[]): number

Get a scaled noise value (using options) at a 2D or 3D point at coords on the surface of a sphere with circumference.

spherical2D(circumference: number, x: number, y: number): number

Specific spherical() call for a 2D point at (x, y).

spherical3D(circumference: number, x: number, y: number, z: number): number

Specific spherical() call for a 3D point at (x, y, z).

🐛 Testing

npm run test

🤝 Contributing

Please see CONTRIBUTING for details.

🔒 Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

🎉 Credits