# Isotope

![CI Status](https://github.com/viniciusmuller/isotope/actions/workflows/ci.yml/badge.svg)

Isotope is a library that provides Elixir bindings to the [bracket-noise](https://crates.io/crates/bracket-noise) crate, which is a rust port of [FastNoise Lite](https://github.com/Auburn/FastNoiseLite).

## Installation

The package can be installed by adding `isotope` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:isotope, "~> 0.2.0"}
  ]
end
```
And running `mix deps.get, deps.compile`.

## Usage

```elixir
opts = %Isotope.Options{
  seed: seed,
  noise_type: :simplex_fractal,
  fractal_options: %Isotope.Options.Fractal{
    octaves: 4
  }
}

{:ok, noise} = Isotope.Noise.new(opts)

Isotope.Noise.noise_map(noise, {1000, 1000})
```

For more information, check the documentation
[here](https://hexdocs.pm/isotope).

## Examples
You can check and run the examples in the `examples` folder.
```bash
mix run examples/<example>.exs
```

## Images
![Output of the terrain.exs example script](images/terrain.png)
![Output of the visualization.exs example script](images/visualization.png)