Skip to content

LittleJS is the tiny fast HTML5 game engine with many features and no dependencies. ๐Ÿš‚ Choo-Choo!

License

Notifications You must be signed in to change notification settings

KilledByAPixel/LittleJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

LittleJS - The Tiny Fast JavaScript Game Engine

LittleJS Screenshot

NPM Package Build Size NPM Downloads DeepScan 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 hybrid rendering, physics, particles, sound, and input handling. The code is clean and well documented with some fun examples to get you started right away. Choo-Choo!

๐Ÿš€ Join the First Ever LittleJS Game Jam

The LittleJS Game Jam will take place From Nov 11 to Dec 12! Unleash your creativity and develop amazing games using the LittleJS game engine. ๐Ÿ•น๏ธ๐ŸŽฎ Sign up today and get more info about the jam on itch.io!

LittleJS Screenshot

About LittleJS Engine

LittleJS is a small but powerful game engine with many features and no dependencies.

โœจ Graphics

  • Super fast sprite and tile map rendering engine with WebGL
  • Update and render 100,000 sprites at a solid 60fps
  • Apply Shadertoy compatible shaders for post-processing effects
  • Robust particle effect system and effect design tool

๐Ÿ”Š Audio

  • Positional sound effects with wave files, mp3s, or ZzFX
  • Use ZzFX sound effect generator to play sounds without asset files
  • Music with mp3, ogg, wave, or ZzFXM

๐ŸŽฎ Input

  • Comprehensive input handling for keyboard, mouse, gamepad, and touch
  • On screen touch gamepad designed for mobile devices

๐Ÿ’ฅ Physics

๐Ÿš€ Flexibility

  • Compatible with all modern web browsers and on mobile devices
  • Support for TypeScript and Modules with example projects for both
  • Ideal for size coding competitions like js13kGames, starter project builds to a 7KB zip
  • Builds to an executable with Electron for distribution on Windows, macOS, and Linux
  • Open Source with the MIT license so it can be used for anything you want forever

๐Ÿ› ๏ธ And more...

  • Node.js build system
  • 2D vector math library
  • Debug primitive rendering system
  • Particle effects system and design tool
  • Bitmap font rendering and includes a built in engine font
  • Medal system tracks and displays achievements with Newgrounds integration

How to use LittleJS

To get started download the latest LittleJS package from GitHub or install via npm: npm install littlejsengine

You will need to run a local web server to run LittleJS games!

This is because web browsers just have protection from loading local files. You may see a console error like "The image element contains cross-origin data." Don't panic, it's easy to fix! If you are using Visual Studio Code there is a Live Preview Extension that will handle this for you automatically. Another option is to setup a simple local web server like http-server via npm.

Examples

These demos are for both learning and using as starter projects to create your own games.

Builds

To easily include LittleJS in your game, you can use one of the pre-built js files.

To rebuild the engine you must first run npm install to setup the necessary npm dependencies. Then call npm run build to build the engine.

The starter example project includes a node js file build.js that compresses everything into a tiny zip file using Google Closure, UglifyJS, and ECT Zip.

Debug builds of LittleJS have a special menu that can be opened by pressing the Esc key.

Games Made With LittleJS

Here are a few of the amazing games people made using LittleJS...

LittleJS Logo