/README.md

https://github.com/bshawk/engine · Markdown · 90 lines · 56 code · 34 blank · 0 comment · 0 complexity · 16a5e3f3a4537f6cb6a39f0255cc35f6 MD5 · raw file 

    

  1. ![PlayCanvas](http://static.playcanvas.com/images/logo/Playcanvas_LOGOSET_SMALL-06.png)
    2. 

  2. 

  3. # PlayCanvas WebGL Game Engine
    4. 

  4. 

  5. PlayCanvas is an open-source game engine. It uses HTML5 and WebGL to run games and other interactive 3D content in all modern browsers without the need for a plugin.
    6. 

  6. 

  7. ## Published games
    8. 

  8. 

  9. Many games have been published using the PlayCanvas engine. Here is a small selection.
    10. 

  10. 

  11. [![Swooop](https://s3-eu-west-1.amazonaws.com/images.playcanvas.com/projects/12/4763/TKYXB8-image-25.jpg)](http://swooop.playcanvas.com) [![Dungeon Fury](https://s3-eu-west-1.amazonaws.com/images.playcanvas.com/projects/12/4450/DVBWHU-image-25.jpg)](http://dungeonfury.playcanvas.com) [![Accelerally](https://s3-eu-west-1.amazonaws.com/images.playcanvas.com/projects/8/3489/RK8NH5-image-25.jpg)](http://apps.playcanvas.com/will/acceleronly/accelerally) [![Going Around](https://s3-eu-west-1.amazonaws.com/images.playcanvas.com/projects/7/3491/HMYM08-image-25.jpg)](http://apps.playcanvas.com/dave/goingaround/goingaround)
    12. 

  12. 

  13. You can see more games on the [PlayCanvas website](https://playcanvas.com/play).
    14. 

  14. 

  15. ## Features
    16. 

  16. 

  17. The PlayCanvas Engine is a fully feature 3D game engine.
    18. 

  18. 

  19. * **Graphics**
    20. 

  20. 	* WebGL-based 3D renderer
    21. 

  21. 	* Ambient, directional, point and spot lights
    22. 

  22. 	* Static and Skinned Meshes
    23. 

  23. 	* Skinned animation support
    24. 

  24. 	* Shadows
    25. 

  25. 	* Seamless default material support from Maya, 3DS Max, Blender, etc.
    26. 

  26. 	* Full model export pipeline from Maya, 3DS Max, Blender, etc via [PlayCanvas Tools](https://playcanvas.com)
    27. 

  27. 	* PostFX library, bloom, bokah, edge detect, fxaa, vignette, etc
    28. 

  28. * **Collision & Physics**
    29. 

  29. 	* Full integration with 3D rigid-body physics engine [ammo.js](https://github.com/kripken/ammo.js)
    30. 

  30. * **Audio**
    31. 

  31. 	* 3D Positional audio via Web Audio API
    32. 

  32. * **Resource Loading**
    33. 

  33. 	* Simple and powerful resource loading
    34. 

  34. * **Entity / Component System**
    35. 

  35. 	* Built-in components for model rendering, animation, audio sources, rigidbodies, collision, trigger volumes
    36. 

  36. * **Scripting system**
    37. 

  37.  	* Write game behaviours by attaching Javascript to game entities.
    38. 

  38. * **Input**
    39. 

  39.  	* Mouse, Keyboard, Touch, Gamepad support
    40. 

  40. 

  41. ## Examples
    42. 

  42. 

  43. See all the [examples](http://playcanvas.github.io) here or browse them locally in the examples directory
    44. 

  44. 

  45. ## How to build
    46. 

  46. 

  47. The PlayCanvas Engine uses the python and the Closure Compiler to build which requires Java.
    48. 

  48. 

  49.     cd build
    50. 

  50.     python build.py
    51. 

  51. 

  52. ## Documentation
    53. 

  53. 

  54. Full documentation available on the [PlayCanvas Developer](http://developer.playcanvas.com) site including [API reference](http://developer.playcanvas.com/engine/api/stable)
    55. 

  55. 

  56. ## How to get models?
    57. 

  57. 

  58. To convert any models created using a 3D modelling package see [this page](http://developer.playcanvas.com/engine/) in the developer documentation.
    59. 

  59. 

  60. ## Getting Help
    61. 

  61. 

  62. [**Answers**](http://answers.playcanvas.com) - Use PlayCanvas Answers to ask specific questions about how to achieve something with the engine
    63. 

  63. 

  64. [**Forums**](http://forum.playcanvas.com) - Use the forum to have more general conversions about PlayCanvas and the Engine
    65. 

  65. 

  66. ## Contributing
    67. 

  67. 

  68. What to help us make the best damn 3D engine on the web? Great!
    69. 

  69. 

  70. ### Github Issues
    71. 

  71. 

  72. Please use Github issues to report bugs or request features.
    73. 

  73. 

  74. ### Reporting bugs
    75. 

  75. 

  76. Please follow these steps to report a bug
    77. 

  77. 

  78. 1. **Search for related issues** - search the existing issues so that you don't create duplicates
    79. 

    80. 

  80. 2. **Create a testcase** - Please create the smallest isolated testcase that you can that reproduces your bug
    81. 

  81. 

  82. 3. **Share as much information as possible** - everything little helps, OS, browser version, all that stuff.
    83. 

  83. 

  84. ## PlayCanvas Platform
    85. 

  85. 

  86. The PlayCanvas Engine is an open source game engine which you can use to create games or render 3D in the browser. In addition to the engine we also make the [PlayCanvas development platform](https://playcanvas.com/) which features a level design tool, asset management and a hosting and publishing service.
    87. 

  87. 

  88. ## License
    89. 

  89. 

  90. The PlayCanvas Engine is released under the [MIT](http://opensource.org/licenses/MIT) license. See LICENSE file.
    91.