Goodluck

A hackable template for creating small and fast browser games.

Goodluck is great for:

• Learning game programming and game design.
• Prototyping gameplay ideas.
• Building size-constrained games.
• Experimenting with algorithms and APIs.
• Modeling problems through animated simulations

Getting Started

Goodluck is not a typical library. You don't install it via npm install. Instead, use it as a template: generate a new repository from it, remove features you don't need, and hack away. Consult the README to learn more.

Generate a new repo on GitHub

Features

Goodluck is a template for creating small browser games which fit in a few kilobytes. It's designed for extreme hackability. The codebase is small and simple; it's mostly just ifs and fors. The code is easy to understand and modify.

• A tiny core with an expressive and fast ECS implementation, which keep the data (components) separate from the logic (systems).
• 3D rendering pipeline supporting Gouraud and Phong shading with gamma-corrected directional and point lights; diffuse, specular, and normal texture mapping; real-time shadows; forward and deferred rendering, both with a post-processing step; instanced rendering, and more.
• A versatile toolkit of useful systems for movement, animation, collisions, particles, entity life cycle (spawn, autodestruct), UI, mouse, keyboard, touch and gamepad input, etc.
• Capable of great performance, even on older mobile devices.

Examples

All examples are WebGL2. The reported sizes are minified and gzipped.

Starter Templates

• NewProject3D 12.4KB
  • Good default with most of Goodluck's components and systems
  • Run ./bootstrap.sh NewProject3D and remove anything you don't need to trim the size even further

Features

• Animate 8.7KB
  • Animation system
  • Skinning
  • Audio listener and spatial audio source
• Context2D 2.1KB
  • A minimal example of Context2D drawing API
• DeferredShading 12.9KB
  • Deferred shading pipeline using light volumes
  • Diffuse, specular, and emissive materials
  • Real-time shadows
  • Bloom, tone-mapping, and FXAA post-processing
  • Smooth-shaded icospheres
• ForwardShading 12.8KB w/o textures
  • Forward shading pipeline
  • Basic shading: points, wireframe, unlit
  • Flat shading via GLSL ES 3.0's flat qualifier
  • Gouraud shading: diffuse, specular x3
  • Phong shading: diffuse, specular x3
  • Textures: unlit, Gouraud (shininess = 0), Phong (shininess = 512), normal and roughness maps
  • Render to texture
  • Real-time shadows
• FirstPerson 7.7KB
  • First-person camera
  • Keyboard, mouse, gamepad and touch controls
  • Fullscreen
  • 2D elements drawn in the 3D space, always facing the camera
• Instancing 5.3KB
  • Instanced draw using cubes to produce voxel-like graphics
• Monkey 5.8KB w/o meshes
  • Meshes exported from Blender (through OBJ)
  • A smooth shaded mesh, specular material
  • A flat shaded mesh, diffuse material
• PathFinding 10.3KB w/o meshes
  • A* path finding on a nav mesh
  • The nav mesh is the same as the rendered terrain mesh
  • Mouse picking (AABB and mesh triangle)
  • Keyboard, mouse, and touch camera controls
• RigidBody 11.5KB
  • AABB Collisions
  • Rigid collision response
  • Gravity
  • Wireframe debug mode
• TodoApp 1.4KB
  • Immediate mode UI
• WebXR 9.9KB
  • 6DoF Controller support
  • A simple hand mesh

Games

• Backcountry
  • A hack-and-slash game set in the Wild West.
  • A submission to js13kGames 2019.
  • The entire game fits into 13 KB zipped.
  • E-book: The Making of Backcountry.
• Time Is Money
  • An incremental game about the passage of time.
  • A submission to Gamedev.js Jam 2020.
• Oh No! All The Textures Are 404!
  • A puzzle game inspired by the Nintendo DS.
  • The entire game fits into 13 KB zipped.
  • A submission to js13kGames 2020.
• ROAR
  • A WebXR game about the zen of destruction.
  • The entire game fits into 13 KB zipped.
  • A submission to js13kGames 2020.
  • E-book: The Making of ROAR.
• Mirrorisk
  • An adaptation of the board game classic Risk.
  • A submission to Gamedev.js Jam 2021.
• ESCAPE
  • A 2.5D puzzle platformer set on Earth abandoned by humans.
  • The entire game fits into 13 KB zipped.
  • A submission to js13kGames 2021 Jam.
• You Are The Snooze Button
  • A 3D adventure about an alarm clock on wheels.
  • A Compo submission to Ludum Dare 50 (2022).
  • Created in less than 48 hours.

Other

• Social Distancing
  • A simulation made in the early days of the COVID-19 pandemic.
• Chain Reaction
  • One of the first 2D experiments with Goodluck.
  • Click to set off explosions and try to destroy all bouncing balls.
• Breakout
  • A Breakout clone made for a workshop. Follow the tutorial branch to learn about ECS and Goodluck.
  • We also ported it to C and Rust.
• Hej
  • One of the first VR experiments with Goodluck.
  • High five!