diff --git a/README.md b/README.md new file mode 100644 index 0000000..3b00e97 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Phaser Isometric Plug-in +======================= + +Phaser Isometric is a comprehensive axonometric plugin for Phaser which provides an API for handling axonometric projection of assets in 3D space to the screen. +The goal has been to mimic as closely as possible the existing APIs provided by Phaser for standard orthogonal 2D projection, but add a third dimension. +Also included is an Arcade-based 3D AABB physics engine, which again is closely equivalent in functionality and its API. + +Features +======== + +* Familiar Phaser API - if you've grasped the basics of Phaser, you can use this! +* 3D geometry helpers in the form of Point3 and Cube +* Adjustable axonometric projection angle to allow for classic 2:1 pixel dimetric, true 30° isometric or any angle you like via ```game.iso.projectionAngle``` +* Calculated depth property for group sorting +* Arcade Physics derived 3D physics engine +* Helpful debug utilities +* Familiar factory methods added to GameObjectFactory and GameObjectCreator so you can do ```game.add.isoSprite``` +* Probably not many bugs!