rot-js/addons/README.md

A roguelike toolkit in JavaScript

rot.js addons
=============

This directory contains "skeleton" files to be re-used and adjusted as necessary. They correspond to common design patterns, utilities and general game architecture modules.

  * `pubsub.js`: simple pub-sub implementation. Suitable for cross-component messaging/notification.
  * `xy.js`: 2D Coords
  * `game.js`: sample main namespace
  * `level.js`: empty level encapsulating entities
  * `entity.js`: abstract displayable game entity
  * `being.js`: rudimentary game being
  * `player.js`: custom game being with keyboard control
  * `textbuffer.js`: buffering text output and displaying it within a ROT.Display subset
  * `sample.html`: working game with a display, level/map and an interactive player character