# hex-pixi-js

> A free hex grid game library for pixijs

Latest version **0.4.2** (published 2015-09-29) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install hex-pixi-js
pnpm add hex-pixi-js
yarn add hex-pixi-js
bun add hex-pixi-js
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.2 |
| Published | 2015-09-29 |
| First published | 2015-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Mark Harmon |
| Maintainers | davidbm |
| Keywords | hexagon, hex, pixijs, pixijs, pixi, grid |

## Links

- npm: https://www.npmjs.com/package/hex-pixi-js
- Repository: https://github.com/DavidBM/HexPixiJs
- Issues: https://github.com/DavidBM/HexPixiJs/issues
- npm.io page: https://npm.io/package/hex-pixi-js

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^2.1.1

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 0.4.2 (latest) — 2015-09-29

## README

HexPixiJs
=========
Basic Hex Grid For PixiJS. Version 0.30 (alpha).

HexPixiJs is a simple library written to give hex grid based game developers a jump start. This library will be updated periodically but there is currently no roadmap of features. Feel free to request features.

Browser
-------
Use `/bin/hexpixi.js` file for the browser.


node/browserify/CommonJS
------------------------
Add this repository to your dependencies, do `npm install` and `require('hex-pixi-js');` in your code.


Disclaimer
----------
This is not supposed to be and end-all solution for making hex grid based games. There is currently no documentation, but the code is fairly simple so I believe there is value for some developers.

Troubleshooting
---------------
I realize there is a CORS (cross origin resource sharing) issue if you are trying to view this without a webserver. In otherwords, if you download the files and double click index.html, the texture might not load.

Files
-----
A brief list and description of the important project files:

* scripts/hexpixi.js -Contains the HexPixiJS library code.
* scripts/hpdemo.js - This javascript code sets up the main demo page and serves as an example of how to use HexPixiJS.
* simpleDemo.html - Demonstrates basic usage of library.
* scripts/simpleDemo.js - Demonstrates basic usage of library.
* simpleDemo2.html - Demonstrates advanced usage of library.
* scripts/simpleDemo2.js - Demonstrates advanced usage of library.

Demo
----
Here is a demo page with a basic map generator on it.
[Map Generator Demo](http://yungsippin.com/hexpixi/)

Simple demo shows barebones usage.
[Simple Demo](http://yungsippin.com/hexpixi/simpleDemo.html)

Simple demo 2 shows interactive map usage.
[Simple Demo 2](http://yungsippin.com/hexpixi/simpleDemo2.html)

License
-------
Released under the [MIT license](http://www.opensource.org/licenses/MIT).

Credits
-------
[PixiJS](http://www.pixijs.com/)

Art assets for simple demo 2 by [Kenney](http://opengameart.org/users/kenney)

Feel free to submit contributions.

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