LittleJS - The Tiny Fast JavaScript Game Engine
🚂 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.
LittleJS Features
✨ Graphics
- Blazing fast WebGL2 + Canvas2D hybrid rendering system
- Apply Shadertoy style shaders for post-processing effects, or on any object or draw
- 2D lights with soft shadows, tinted glass and emissive objects, a sun with long shadows, spotlight cones and gels, and normal maps
- Robust particle effect system with a library of ready made effects and an effect design tool
- Parallax background layers that repeat across a level of any size
- Load sprites and animations into texture sheets at runtime, or import TexturePacker and Aseprite atlases
🧊 LittleJS 3D
- Built-in 3D renderer that shares the canvas with your 2D game
- 3D objects with the same physics, children and timers as 2D
- Shape builders, extruded sprites and text, and OBJ and glTF model loading
- Height map terrain and voxel maps with collision and raycasts
- 3D levels and prefabs, built in the 3D level editor and loaded with one call
- Shadow maps, colored lights, spotlights, lens flares, specular, emissive glow and fog
- Reflections of a sky box or the scene itself, from mirror sharp to rough
- Particles, trails, billboards and instanced drawing
- Orbit, chase and first person cameras with mouse picking
- Custom shaders on any object
- Optional Three.js plugin as an alternative renderer
🔊 Audio
- Sound and music with mp3, ogg, or wave files
- Use ZzFX sound generator to play sounds without asset files
- Spatial audio with stereo panning
- Audio effects plugin with filter, reverb, delay, distortion and compressor
- Comprehensive input handling for mouse, keyboard, gamepad, and touch
- Customizable on screen gamepad designed for mobile devices
- Pinch to zoom on touch screens, read the same way as the mouse wheel
💥 Physics
- Robust arcade physics system with collision handling
- Fast tilemap collision and raycasting, with one-way platforms that turn with their tiles
- Swept bullet collision, so small fast objects never pass through a wall
- Object collision that stays fast with thousands of objects
- Full Box2D integration for realistic physics using Box2D v2.3.1 wasm
- Grid-based A* pathfinding plugin with optional path smoothing
🚀 Flexibility
- Compatible with all modern web browsers and mobile devices
- Full TypeScript and Module support with example projects for both
- Vite starter template for instant dev server with hot reload
- Great for size coding competitions like Js13kGames
- Open Source and MIT licensed
- Live example browser with code editor
- Built-in 2D and 3D level editors that edit your game while it runs, with undo, autosave and prefabs
- Make the editors your own with your game’s own object types, keys, buttons and tools, see the editor guide
- 2D levels load and save as Tiled JSON, so Tiled can edit them too
- UI system with buttons, sliders, text input and nine-slice skins
- Tween system with easing curves, and a scene system for titles, menus and game states
- Debug overlay and primitive rendering system
- Medals, leaderboards and cloud saves on Newgrounds and Wavedash
- Node.js build system
🤖 AI Friendly
- The entire API is small and well documented so LLMs can produce high quality results
- LittleJS AI Tools - Templates, examples, and prompts tuned for AI + LittleJS workflows
- LittleJS GPT - Build LittleJS games right inside ChatGPT
How To Use LittleJS
To get started download the latest release from GitHub, the engine’s builds and source as npm has them (the examples are in the repository), or install via npm:
npm install littlejsengine
or use degit for an empty Vite template
npx degit KilledByAPixel/LittleJS/examples/vite-starter my-game
cd my-game
npm install
npm run dev
The examples are only in the repository: clone it, or use Download ZIP on its GitHub page; the npm package and the release zip hold the engine alone. A page that loads images or modules needs a local web server, as browsers block them from a file on disk: serve the repository’s root, for example with npx http-server, then open http://localhost:8080/examples/starter/, the place to start. The FAQ has more.
Here is a minimal Hello World example game, with the script path pointing at the engine file from the download or npm package; it loads nothing, so it runs straight from the file.
<!DOCTYPE html>
<script src="node_modules/littlejsengine/dist/littlejs.js"></script>
<script>
function gameInit() {}
function gameUpdate() {}
function gameUpdatePost() {}
function gameRender() {}
function gameRenderPost() { drawTextScreen('Hello World!', mainCanvasSize.scale(.5), 80); }
engineInit(gameInit, gameUpdate, gameUpdatePost, gameRender, gameRenderPost);
</script>
Tutorials
Examples
LittleJS comes with several demos both for learning and using as starter projects to create new games.
- Example Browser - Live example browser with all examples and editable source
- LittleJS Arcade - Over 50 example games you can use as starter projects
- Short Examples - 100+ single-file demos showing off individual engine features
- Breakout - Block breaking game with post-processing effects
- Puzzle Game - Match 3 puzzle game with HD rendering and high score tracking
- Platformer - Platformer/shooter demo that loads level data
- Box2D Demo - Box2D plugin demonstration and testbed
- 3D Example - The 3D plugin in one scene: terrain, shadows, lights, sprites, particles and bloom
- 3D Racing Game - Built-in 3D plugin: terrain, shadows and a chase camera in one short file
- Three.js Platformer - 3D platformer with LittleJS gameplay and Three.js rendering
- Particle System Designer - Particle system editor and visualizer
Builds
Every build includes the plugins. littlejs.min.js is about 135 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 26 KB gzipped, and a lit 3D scene to about 47 KB.
Games Made With LittleJS
Here are a few of the many amazing games created with LittleJS…
A sample of games built with LittleJS.
评论