@scarletsky/playcanvas

PlayCanvas WebGL game engine

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
15Jun 1, 2021May 12, 2017Minified + gzip package size for @scarletsky/playcanvas in KB

Readme

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:

After The Flood Master Archer Disney: Hour of Code WebVR Lab
TANX Swooop Flappy Bird Virtual Voodoo
Space Base Sponza Runtime Lightmaps Star-Lord Orange Room VR
Car Steampunk Slots Casino Seemore

You can see more games on the PlayCanvas website.

Users

PlayCanvas Engine and Tools been used by leading companies in game development, automotive, digital agencies and more. Some of them are:
Disney, King, Zynga, Miniclip, Nickelodeon, Leapfrog, IGT, ARM, Samsung, Mozilla, Facebook

Features

The PlayCanvas Engine is a fully featured game engine.

  • Graphics
    • WebGL 2.0 based renderer (with fallback to WebGL 1.0)
    • Physically based rendering (PBR)
    • Directional, point and spot lights
    • Shadow mapping (PCF and VSM implementations)
    • Runtime lightmap baking
    • Static, skinned and morphed 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 Assets User Manual
  • 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
    • Streaming of individual assets
    • Asset Variants - loads compressed textures (DXT, PVR, ETC1) based on platform support
  • Entity / Component System
    • Built-in components: model, sound, animation, camera, collision, light, rigidbody, script, particlesystem
  • Scripting system
    • Write game behaviors by attaching JavaScript to game entities
    • Live code hot-swap enables rapid iteration
  • Input
    • Mouse, Keyboard, Touch, Gamepad, VR

Usage

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

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>PlayCanvas Hello Cube</title>
    <meta name='viewport' content='width=device-width, initial-scale=1, maximum-scale=1, minimum-scale=1, user-scalable=no' />
    <style>
        body {
            margin: 0;
            overflow: hidden;
        }
    </style>
    <script src='https://code.playcanvas.com/playcanvas-stable.min.js'></script>
</head>
<body>
    <canvas id='application'></canvas>
    <script>
        // create a PlayCanvas application
        var canvas = document.getElementById('application');
        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);

        // ensure canvas is resized when window changes size
        window.addEventListener('resize', function() {
            app.resizeCanvas();
        });

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

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

        // create directional light entity
        var light = new pc.Entity('light');
        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 a global update event
        app.on('update', function (deltaTime) {
            cube.rotate(10 * deltaTime, 20 * deltaTime, 30 * deltaTime);
        });
    </script>
</body>
</html>

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

Tutorials & Examples

See all the tutorials here.

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.

How to build

  • Ensure you have nodejs installed
  • Ensure you have Java installed.

The first time you build you will be asked to install dependencies using npm. e.g.

npm install fs-extra
npm install google-closure-compiler
npm install preprocessor

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

cd build
node build.js

See the built in help for more build instructions

node build.js -h

Pre-built versions of the engine are also available.

Latest development release:

Latest stable release:

Specific engine versions:

Getting Help

Forums - Use the forum to ask/answer questions about PlayCanvas.

Discord - Real-time text, voice and video chat for the PlayCanvas developer community.

Contributing

Want to help us make the best 3D engine on the web? Great! Check out CONTRIBUTING.md that will get you started. And look for "good first PR" label in Issues.

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 engine which you can use to create games and 3D visualisation in the browser. In addition to the engine we also make the PlayCanvas development platform which features an Visual Editor, asset management, code editing, hosting and publishing services.

License

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.