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

Guidelines

Goodluck is a template for creating small browser games which fit in a few kilobytes. Apart from the game loop and the rendering pipeline, Goodluck doesn't give you much more code. We like to think of Goodluck as a set of good practices, architecture decisions, and tools.

1. Write code that you need just for this game. Don't design extensible abstractions. Your goal is to ship a game, not to build an engine.
2. Write data-driven code. Goodluck uses the ECS architecture; separate the data (components) from the logic (systems).
3. Prefer simple procedural code and closed type systems. E.g. instead of designing class inheritance hierarchies, use union types and switch between the variants.

Examples

All examples are WebGL2. The reported size is minified and gzipped.

Starter Templates

• NewProject3D 10.9KB
  • Good default with most of Goodluck's components and systems
• Minimal3D 5.0KB
  • Lights, camera, forward rendering.
• Minimal2D 1.9KB
  • Context2D drawing API

Features

• Animate 8.2KB
  • Animation system
  • Skinning
  • Audio listener and spatial audio source
• DeferredShading 9.5KB
  • Deferred shading pipeline with up to 64 lights
  • Real-time shadows
  • Smooth-shaded icospheres
• ForwardShading 10.9KB w/o textures
  • 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
• ForwardShadows 6.0KB
  • Forward shading pipeline
  • Real-time shadows
• FirstPerson 6.9KB
  • First-person camera
  • Keyboard, mouse, gamepad and touch controls
  • Fullscreen
  • 2D elements drawn in the 3D space, always facing the camera
• Instancing 4.2KB
  • Instanced draw using cubes to produce voxel-like graphics
• Monkey 4.6KB w/o meshes
  • Meshes exported from Blender (through OBJ)
  • A smooth shaded mesh, specular material
  • A flat shaded mesh, diffuse material
• Particles 4.2KB
  • Particle emitter using GL_POINTS
  • Colored and textured particles
  • Tiny flame texture inlined into the code on buildtime
• PathFinding 9.5KB 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
• RenderTexture 5.4KB w/o textures
  • Render to texture
• RigidBody 9.7KB
  • AABB Collisions
  • Rigid collision response
  • Gravity
• TodoApp 1.0KB
  • Immediate mode UI
• Trigger 6.6KB
  • AABB collisions
  • Trigger on collision
  • Wireframe debug mode
• WebXR 8.3KB
  • 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.

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!