Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
neki-dev committed Dec 29, 2023
1 parent 3e3f0a3 commit b2b0311
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,21 @@ Procedural generation 2D map with biomes

.

* ### [Demo](https://gen-biome.neki.guru/)
[Demo](https://gen-biome.neki.guru/)

* ### Install
Documentation

* [Install](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#install)
* [Generator](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#generator)
* [Layers](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#layers)
* [Biomes](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#biomes)
* [Generation](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#generation)
* [World](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#world)
* [Example](https://github.com/neki-dev/gen-biome?tab=readme-ov-file#example)

.

## Install

```sh
npm i gen-biome
Expand Down Expand Up @@ -87,7 +99,6 @@ layer.clearBiomes()
.
## Generation
#### Generate world
```ts
const world: World = generator.generate(params?)
Expand All @@ -102,7 +113,6 @@ const world: World = generator.generate(params?)
.
## World
#### Get matrix of biomes data
```ts
const matrix: T[][] = world.getMatrix()
Expand Down Expand Up @@ -157,7 +167,6 @@ const height: number = world.height
```ts
const TILE_SIZE = 2;

const BIOMES = [
{ // WATER
params: { lowerBound: 0.0, upperBound: 0.2 },
Expand Down

0 comments on commit b2b0311

Please sign in to comment.