starwards / pixi-field-of-view

Render top-down field-of-view layers in Pixi.js

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Archived - reference only

This repository was meant to be used to calculate field of view using GPU shaders for the starwards game, but we decided to forego this design approach and implement it in the game core logic instead. As it was refered in some external correspondence, This repository is left archived as-is.

pixi-field-of-view

npm version

pixi-field-of-view allows you to add shadows and lights to your pixi stage. The lights themselves are very simple, and this plugin purely focuses on the shadows.

This repository is a fork of pixi-shadows. Most of the hard work was done by TarVK.

How to use

documentation pending

Installation

npm install pixi-field-of-view

or, clone and build this repository, then copy the pixi-field-of-view commonjs script or umd script manually for usage without npm.

Vanilla JS, UMD build

All pixiJS v6 plugins has special umd build suited for vanilla. Navigate pixi-field-of-view npm package, take dist/pixi-field-of-view.umd.js file. Also, you can access CDN link, something like https://cdn.jsdelivr.net/npm/pixi-field-of-view@latest/dist/pixi-field-of-view.umd.js.

<script src='lib/pixi.js'></script>
<script src='lib/pixi-field-of-view.umd.js'></script>

All classes can then be accessed through PIXI.fov package.

About

Render top-down field-of-view layers in Pixi.js

License:MIT License


Languages

Language:TypeScript 92.5%Language:JavaScript 6.9%Language:HTML 0.6%