https://github.com/flauwekeul/honeycomb

Create hex grids easily, in node or the browser.
https://github.com/flauwekeul/honeycomb

grid hex hex-grid-library hexagonal-grids hexes node typescript

Last synced: about 1 month ago
JSON representation

Create hex grids easily, in node or the browser.

• Host: GitHub
• URL: https://github.com/flauwekeul/honeycomb
• Owner: flauwekeul
• License: mit
• Created: 2016-06-07T19:19:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-09T21:20:30.000Z (11 months ago)
• Last Synced: 2024-10-30T01:37:28.343Z (about 1 month ago)
• Topics: grid, hex, hex-grid-library, hexagonal-grids, hexes, node, typescript
• Language: TypeScript
• Homepage: https://abbekeultjes.nl/honeycomb
• Size: 9.75 MB
• Stars: 638
• Watchers: 18
• Forks: 58
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - flauwekeul/honeycomb - Create hex grids easily, in node or the browser. (typescript)
• awesome - flauwekeul/honeycomb - Create hex grids easily, in node or the browser. (TypeScript)
• awesome - flauwekeul/honeycomb - Create hex grids easily, in node or the browser. (TypeScript)

README

        
# ⬡ Honeycomb [![NPM version](https://img.shields.io/npm/v/honeycomb-grid.svg)](https://www.npmjs.com/package/honeycomb-grid) [![Minified size](https://img.shields.io/bundlephobia/min/honeycomb-grid.svg)](https://www.npmjs.com/package/honeycomb-grid) [![Gitter](https://img.shields.io/gitter/room/flauwekeul/honeycomb.svg)](https://gitter.im/honeycomb-grid)

A hexagon grid library made in ~~JavaScript~~[TypeScript](https://www.typescriptlang.org/), heavily inspired by [Red Blob Games'](http://www.redblobgames.com/grids/hexagons/) blog posts and code samples.

Honeycomb works in modern browsers and Node (>=16). It's recommended to use Honeycomb with TypeScript, but not required.

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I24E3QI)

## Installation

NPM:

```bash

npm i honeycomb-grid

```

Yarn:

```bash

yarn add honeycomb-grid

```

Or download the distribution from [jsdelivr](https://cdn.jsdelivr.net/npm/honeycomb-grid) or [unpkg.com](https://unpkg.com/honeycomb-grid).

## Basic example

Create a rectangular grid of 10 by 10 hexes and log each hex:

```javascript

import { defineHex, Grid, rectangle } from 'honeycomb-grid'

// 1. Create a hex class:

const Tile = defineHex({ dimensions: 30 })

// 2. Create a grid by passing the class and a "traverser" for a rectangular-shaped grid:

const grid = new Grid(Tile, rectangle({ width: 10, height: 10 }))

// 3. Iterate over the grid to log each hex:

grid.forEach(console.log)

```

## Documentation

Documentation is available at [abbekeultjes.nl/honeycomb](https://abbekeultjes.nl/honeycomb). API docs can be found at [abbekeultjes.nl/honeycomb/api/](https://abbekeultjes.nl/honeycomb/api/).

## Backlog

These are ideas that may require further investigation 🕵️. Don't hesitate to [open an issue](https://github.com/flauwekeul/honeycomb/issues) or [start a discussion](https://github.com/flauwekeul/honeycomb/discussions).

- [ ] Directions should also be given in degrees (in steps of 30°)?

- [ ] Add functionality related to [edges](https://github.com/flauwekeul/honeycomb/issues/58#issuecomment-642099947) and/or corners. Use https://www.redblobgames.com/grids/parts/#hexagons.

- [x] Add path finding (e.g. A*) functionality. Currently available as an example, see `/examples/a-star-path-finding/`.

- [ ] Clarify the "Line of sight" example (and rename to "Field of view"). Maybe add animations and some enemies as well?

- [ ] Add examples for (procedural) map generation (from a seed).