LittleJS 1.30.1

LittleJS - The Tiny Fast JavaScript Game Engine

LittleJS Logo

NPM Package NPM Downloads DeepScan MIT License Discord

🚂 All Aboard!

LittleJS is a fast, lightweight, and fully open source HTML5 game engine designed for simplicity and performance. Its small footprint is packed with a comprehensive feature set including 2D and 3D rendering, physics, particles, sound, and input handling. The code is very clean and well documented with many examples to get you started quickly.

New here? Open the example browser and change the code of any example while it runs, or jump to Quick Start and have a game on screen in a minute.

Examples | Arcade | Docs | Reference | FAQ | Trailer | Discord | AI

LittleJS Screenshot1

LittleJS Screenshot2

LittleJS Features

✨ Graphics

🧊 LittleJS 3D

🔊 Audio

🎮 Input

💥 Physics

🧩 Game Systems

🚀 Flexibility

🛠️ Developer Tools

🤖 AI Friendly

Quick Start

Try it in the browser

The example browser runs every example beside its code. Edit the code and the example restarts with your change, and each one comes with a write-up of how it works and a few things to try. There is nothing to install.

One HTML file

Download the latest release from GitHub, or run npm install littlejsengine, then save this as index.html with the script path pointing at the engine file. It loads nothing else, so it runs straight from the file with no server. Click to set off an explosion.

<!DOCTYPE html>
<script src="node_modules/littlejsengine/dist/littlejs.js"></script>
<script>
function gameInit() {}       // called once after the engine starts
function gameUpdate()        // called 60 times a second for game logic
{
    if (mouseWasPressed(0))
        particleEffect('explosion', mousePos);
}
function gameUpdatePost() {} // called after physics, even when paused
function gameRender() {}     // called before objects are drawn
function gameRenderPost()    // called after objects are drawn
{
    drawTextScreen('Hello World!', mainCanvasSize.scale(.5), 80);
}
engineInit(gameInit, gameUpdate, gameUpdatePost, gameRender, gameRenderPost);
</script>

Those five functions are the whole shape of a LittleJS game. From here, the Breakout tutorial builds a complete game in about 30 minutes.

Start a project

Pick the setup that suits you. All three use the same engine and the same API.

With Vite, for a dev server that reloads on save and a build that leaves out the plugins you do not use:

npx degit KilledByAPixel/LittleJS/examples/vite-starter my-game
cd my-game
npm install
npm run dev

With npm, in a project of your own. TypeScript types are included.

npm install littlejsengine
import * as LJS from 'littlejsengine';

With a script tag and no build step: clone this repository, or use Download ZIP on its GitHub page, and copy examples/starter. Every engine name is a global, as in the example above. The examples are only in the repository; the npm package and the release zip hold the engine alone.

A page that loads images or modules needs a local web server, since browsers block them from a file on disk. Vite brings its own. For the repository, serve its root, for example with npx http-server, then open http://localhost:8080/examples/starter/. The FAQ has more.

Learn

Documentation

Examples

LittleJS comes with many examples, both for learning and to use as starter projects for new games.

Builds

File Mode Module Use case
littlejs.js Debug No Debug mode with asserts
littlejs.release.js Release No Optimized for release
littlejs.min.js Release No Optimized for release and minified
littlejs.esm.js Debug ESM Debug mode with asserts
littlejs.esm.min.js Release ESM Optimized for release and minified

Develop with a debug build: it has the asserts that catch mistakes, the debug overlay (press Esc) and the level editors. Ship a release build, which leaves all of that out. TypeScript definitions are in littlejs.d.ts, which the npm package sets up on its own.

Every build includes the plugins. littlejs.min.js is about 165 KB gzipped, and the 3D plugins are a large part of that. A bundler like Vite leaves out the plugins a game does not use, so a small 2D game comes to about 29 KB gzipped, and a lit 3D scene to about 72 KB.

Games Made With LittleJS

Here are a few of the many amazing games created with LittleJS...

A collage of screenshots from games made with LittleJS

A sample of games built with LittleJS.

Community

LittleJS is MIT licensed, free for any use.

LittleJS pixel-art favicon