castle-ravenloft-navigator/README.md

An API to calculate the precedence diagram method

<h1><a href="https://github.com/FireboltCasters/Castle-Ravenloft-Navigator"><img src="https://raw.githubusercontent.com/FireboltCasters/Castle-Ravenloft-Navigator/main/icon.png" width="100" heigth="100" /></a><a href="https://github.com/FireboltCasters/Castle-Ravenloft-Navigator">castle-ravenloft-navigator</a></h1>

<h2>A library and tool to find the shortest path inside the castle raventloft</h2>

<p align="center">
  <a href="https://badge.fury.io/js/castle-ravenloft-navigator.svg"><img src="https://badge.fury.io/js/castle-ravenloft-navigator.svg" alt="npm package" /></a>
  <a href="https://img.shields.io/github/license/FireboltCasters/Castle-Ravenloft-Navigator"><img src="https://img.shields.io/github/license/FireboltCasters/Castle-Ravenloft-Navigator" alt="MIT" /></a>
  <a href="https://img.shields.io/github/last-commit/FireboltCasters/Castle-Ravenloft-Navigator?logo=git"><img src="https://img.shields.io/github/last-commit/FireboltCasters/Castle-Ravenloft-Navigator?logo=git" alt="last commit" /></a>
  <a href="https://www.npmjs.com/package/castle-ravenloft-navigator"><img src="https://img.shields.io/npm/dm/castle-ravenloft-navigator.svg" alt="downloads week" /></a>
  <a href="https://www.npmjs.com/package/castle-ravenloft-navigator"><img src="https://img.shields.io/npm/dt/castle-ravenloft-navigator.svg" alt="downloads total" /></a>
  <a href="https://github.com/google/gts" alt="Google TypeScript Style"><img src="https://img.shields.io/badge/code%20style-google-blueviolet.svg"/></a>
  <a href="https://shields.io/" alt="Google TypeScript Style"><img src="https://img.shields.io/badge/uses-TypeScript-blue.svg"/></a>
  <a href="https://github.com/marketplace/actions/lint-action"><img src="https://img.shields.io/badge/uses-Lint%20Action-blue.svg"/></a>
</p>


## Live Demo

Live Demo: https://fireboltcasters.github.io/Castle-Ravenloft-Navigator/

<a href="https://fireboltcasters.github.io/Castle-Ravenloft-Navigator/"><img src="https://raw.githubusercontent.com/FireboltCasters/Castle-Ravenloft-Navigator/main/demo.png" alt="Demo" /></a>

## Web Usage
- Visit the demo page
- Select your start and destination room
- Click on the "Navigate" button

## Roadmap

- Add secret doors to be enabled by the DM [done]
- Add custom URL for players [done]
- Add custom URL for DM [no need]


## Installtion

```
npm install castle-ravenloft-navigator
```

## Usage

//TODO

```ts
import {...} from "castle-ravenloft-navigator";
```

## Contributors

The FireboltCasters

<a href="https://github.com/FireboltCasters/Castle-Ravenloft-Navigator"><img src="https://contrib.rocks/image?repo=FireboltCasters/Castle-Ravenloft-Navigator" alt="Contributors" /></a>