# forgotten-realms-map

> Create and display interactive fantasy maps for web-based game projects.

Latest version **2.0.2** (published 2024-04-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install forgotten-realms-map
pnpm add forgotten-realms-map
yarn add forgotten-realms-map
bun add forgotten-realms-map
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2024-04-17 |
| First published | 2024-03-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Liam Neeson |
| Maintainers | nicolejoganic |
| Keywords | fantasy, map, interactive, game, realms |

## Links

- npm: https://www.npmjs.com/package/forgotten-realms-map
- npm.io page: https://npm.io/package/forgotten-realms-map

## Dependencies (5)

- [d3](https://npm.io/package/d3.md) ^6.6.0
- [three](https://npm.io/package/three.md) ^0.126.1
- [leaflet](https://npm.io/package/leaflet.md) ^1.7.1
- [pixi.js](https://npm.io/package/pixi.js.md) ^6.0.4
- [topojson](https://npm.io/package/topojson.md) ^3.0.2

## Recent versions

- 2.0.2 (latest) — 2024-04-17
- 2.0.1 — 2024-03-20
- 2.0.0 — 2024-03-20
- 1.0.0 — 2024-03-18

## README

# Forgotten Realms Map

The `forgotten-realms-map` library leverages the power of `leaflet` and `d3` to render interactive maps of fantasy realms. Designed for developers looking to integrate a fantasy map into their projects, this library simplifies the process of adding custom interactive maps to web applications.

## Features

- Utilizes `leaflet` for map interactions.
- Uses `d3` for adding custom SVG elements and animations.
- Easy to integrate with any web project.
- Supports custom markers for significant locations on the map.

## Installation

To install the `forgotten-realms-map`, use npm:

```bash
npm install forgotten-realms-map
```

## Usage

First, make sure to include Leaflet's CSS in your project for the map to display correctly. You can include it in your HTML:

```html
<link rel="stylesheet" href="//unpkg.com/leaflet/dist/leaflet.css" />
```

Then, you can use the `ForgottenRealmsMap` class in your JavaScript file as follows:

```javascript
import ForgottenRealmsMap from 'forgotten-realms-map';

// Initialize the map by passing the ID of the div where the map should be rendered
const map = new ForgottenRealmsMap('mapId', { /* options here */ });

```

### HTML Structure

Ensure you have a div element with the ID that matches the one you provide to the constructor:

```html
<div id="mapId" style="height: 500px;"></div>
```

## Options

You can pass an options object to the `ForgottenRealmsMap` constructor to customize the map. Currently, the library supports the following options:

- `optionName`: Description of what it does.

## Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any suggestions or find any bugs.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

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