Skip to content
3D WebGL game engine with online toolset.
Branch: master
Clone or download
Pull request Compare This branch is 3127 commits behind playcanvas:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
contrib
examples
extras
src
tests
.gitignore
CONTRIB.md
LICENSE
README.md
VERSION

README.md

PlayCanvas

PlayCanvas WebGL Game Engine

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.

Project Showcase

Many games and apps have been published using the PlayCanvas engine. Here is a small selection:

TANX Car Swooop
Afterglow Star-Lord Orange Room
Steampunk Slots Casino Seemore

You can see more games on the PlayCanvas website.

Features

The PlayCanvas Engine is a fully featured 3D game engine.

  • Graphics
    • WebGL-based 3D renderer
    • Physically based rendering (PBR)
    • Directional, point and spot lights (all of which can cast shadows)
    • Static and skinned meshes
    • GPU Particle engine with editor
    • PostFX library: bloom, edge detect, FXAA, vignette, etc
    • Seamless default material support from Maya, 3DS Max, Blender, etc.
    • Full model export pipeline from Maya, 3DS Max, Blender, etc via PlayCanvas Tools
  • Collision & Physics
    • Full integration with 3D rigid-body physics engine ammo.js
  • Audio
    • 3D Positional audio via Web Audio API
  • Resource Loading
    • Simple and powerful resource loading
  • Entity / Component System
    • Built-in components: audiosource, animation, camera, collision, light, rigidbody, script
  • Scripting system
    • Write game behaviours by attaching JavaScript to game entities.
  • Input
    • Mouse, Keyboard, Touch, Gamepad support

Usage

Here's a super-simple Hello World example - a spinning cube!

<script>
    // Create a PlayCanvas application
    var canvas = document.getElementById("application-canvas");
    var app = new pc.Application(canvas, {});
    app.start();

    // Fill the available space at full resolution
    app.setCanvasFillMode(pc.FILLMODE_FILL_WINDOW);
    app.setCanvasResolution(pc.RESOLUTION_AUTO);

    // Create box entity
    var cube = new pc.Entity();
    cube.addComponent("model", {
        type: "box"
    });

    // Create camera entity
    var camera = new pc.Entity();
    camera.addComponent("camera", {
        clearColor: new pc.Color(0.1, 0.1, 0.1)
    });

    // Create directional light entity
    var light = new pc.Entity();
    light.addComponent("light");

    // Add to hierarchy
    app.root.addChild(cube);
    app.root.addChild(camera);
    app.root.addChild(light);

    // Set up initial positions and orientations
    camera.setPosition(0, 0, 3);
    light.setEulerAngles(45, 0, 0);

    // Register an update event
    app.on("update", function (deltaTime) {
    	cube.rotate(10 * deltaTime, 20 * deltaTime, 30 * deltaTime);
    });
</script>

Want to play with the code yourself? Edit it on CodePen.

Examples

See all the examples here or browse them locally in the examples directory

How to build

  • Ensure you have Python installed (supported version is 2.7)
  • Ensure you have Java installed.

Then, to execute a build of the engine to the build/output folder, do:

cd build
python build.py

Documentation

Full documentation available on the PlayCanvas Developer site including API reference

Releases

A full list of Releases and Release Notes is available here.

How to get models?

To convert any models created using a 3D modelling package see this page in the developer documentation.

Getting Help

Answers - Use PlayCanvas Answers to ask specific questions about how to achieve something with the engine

Forums - Use the forum to have more general conversions about PlayCanvas and the Engine

Contributing

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

Github Issues

Please use Github issues to report bugs or request features.

Reporting bugs

Please follow these steps to report a bug

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

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

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

PlayCanvas Platform

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 which features a level design tool, asset management and a hosting and publishing service.

License

The PlayCanvas Engine is released under the MIT license. See LICENSE file.

You can’t perform that action at this time.