# simpledungeongenerator

> A simple dungeon generator for roguelike games.

Latest version **0.9.6** (published 2023-10-09) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.6 |
| Published | 2023-10-09 |
| First published | 2023-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 364.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Purukitto |
| Maintainers | purukitto |
| Keywords | dungeon, generator, dungeon-generator, dungeon-crawler, dungeon-crawler-generator, dungeon-crawler-game, dungeon-crawler-game-dungeon-generator, simpleDungeonGenerator, map-generator, dungeon-map |

## Links

- npm: https://www.npmjs.com/package/simpledungeongenerator
- Homepage: https://github.com/Purukitto/simpleDungeonGenerator#readme
- Issues: https://github.com/Purukitto/simpleDungeonGenerator/issues
- npm.io page: https://npm.io/package/simpledungeongenerator

## Dependencies (1)

- [seedrandom](https://npm.io/package/seedrandom.md) ^3.0.5

## Recent versions

- 0.9.6 (latest) — 2023-10-09
- 0.9.5 — 2023-10-09
- 0.9.4 — 2023-10-09
- 0.9.3 — 2023-10-08
- 0.9.2 — 2023-10-08
- 0.9.1 — 2023-10-08
- 0.9.0 — 2023-10-08
- 0.8.0 — 2023-10-06
- 0.7.3 — 2023-10-02
- 0.7.2 — 2023-10-02
- 0.7.1 — 2023-10-02
- 0.7.0 — 2023-10-02
- 0.6.4 — 2023-10-01
- 0.6.3 — 2023-10-01
- 0.6.2 — 2023-10-01
- … 8 more at https://npm.io/package/simpledungeongenerator/versions

## README

# Simple Dungeon Generator

A simple dungeon generator for javascript (typed) and the browser with only one dependency (for seeded random numbers).

Highly configurable, but with sensible defaults.

![GitHub release (with filter)](https://img.shields.io/github/v/release/Purukitto/simpleDungeonGenerator) ![GitHub issues](https://img.shields.io/github/issues/purukitto/simpleDungeonGenerator) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/purukitto/simpleDungeonGenerator/main.yml) [![npm](https://img.shields.io/npm/v/simpledungeongenerator)](https://www.npmjs.com/package/simpledungeongenerator) ![npm bundle size](https://img.shields.io/bundlephobia/min/simpledungeongenerator)

Demo: https://purukitto.github.io/SDGdemo/

See the latest changelog [here](./CHANGELOG.md)

## Installation

### npm

```bash
npm install simpledungeongenerator
```

### yarn

```bash
yarn add simpledungeongenerator
```

## Usage

Simplest dungeon with:

```typescript
// ESM
import simpleDungeon from "simpledungeongenerator";

const dungeon = new simpleDungeon();

dungeon.drawToConsole();
```

```javascript
// CJS
const simpleDungeon = require("simpledungeongenerator").default;

const dungeon = new simpleDungeon();

dungeon.drawToConsole();
```

```html
<!-- Browser -->
<!-- path to bundle -->
<script src="./node_modules//simpledungeongenerator/dist/bundle.js"></script>
<script>
	const dungeon = simpleDungeon();
	const svgContainer = document.getElementById("svg-container"); // SVG container
	dungeon.drawToSVG(svgContainer, 5, {
		withIndex: true,
		withColour: true,
	});
</script>
```

## Options

| Option         | Type   | Default      | Description                                               |
| -------------- | ------ | ------------ | --------------------------------------------------------- |
| seed           | string | "purukitto"  | Seed for the random number generator                      |
| maxH           | number | 50           | Maximum height of the dungeon                             |
| maxW           | number | 50           | Maximum width of the dungeon                              |
| type           | string | "Base"       | Type of the dungeon to generate (Currently has no effect) |
| roomTries      | number | 150          | Number of times to try to generate a room                 |
| extraRoomSize  | number | 0            | Extra size to add to the room                             |
| windingPercent | number | 50           | Percentage of the dungeon to be winding                   |
| tiles          | Object | defaultTiles | Tiles to use for the dungeon                              |
| startIndex     | number | 1            | Index to start the dungeon from                           |

## Properties

| Property | Type       | Description                              |
| -------- | ---------- | ---------------------------------------- |
| map      | object[][] | A 2D array representing the dungeon map. |
| rooms    | Room[]     | An array of rooms in the dungeon         |
| tiles    | Object     | The tiles used for the dungeon           |

## Methods

| Method          | Description                      |
| --------------- | -------------------------------- |
| drawToConsole() | Draws the dungeon to the console |
| drawToSVG()     | Draws the dungeon to an SVG      |

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](./LICENSE.md)

## Acknowledgements

-   [seedrandom](https://github.com/davidbau/seedrandom) - Seedable random number generator
-   [Article](https://journal.stuffwithstuff.com/2014/12/21/rooms-and-mazes/) - Fabulous article on dungeon generation
-   [changesets](https://github.com/changesets/changesets/tree/main) - Used for managing changelogs and releases
-   [Rollup](https://rollupjs.org/) - Used for bundling the library

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