JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q60446F
  • License AGPL-3.0-or-later

PIXI.js based renderer to create 5d chess boards based off of 5d-chess-js

Package Exports

  • 5d-chess-renderer
  • 5d-chess-renderer/dist/5d-chess-renderer.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (5d-chess-renderer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

5D Chess Renderer

Pipeline Status NPM version

PIXI.js based renderer to create 5d chess boards based off of 5d-chess-js.

What does 5D Chess Renderer do?

  • Render boards and pieces using 5d-chess-js data
  • Render previous moves and actions as arrows
  • Provide configuration / palette options
  • Handle mouse / touch events for zooming, panning, move selection, and arrow drawing

What does 5D Chess Renderer not do?

  • Does not handle keyboard events
  • Does not handle sound
  • Does not handle additional GUI elements (submitting, undo, forfeit, chess clock, etc.)

Documentation

Documentation is available here!

To run local copy, use the command npm run docs-start.

All source code is released under AGPL v3.0 (license can be found under the LICENSE file).

Chess piece images were derived from SVG files released under CC BY-SA v3.0 (license can be found under the PIECE_LICENSE file).

Any addition copyrightable material not covered under AGPL v3.0 is released under CC BY-SA v3.0.