Introducing Phaser + Box2D

A couple of months ago – three to tell the truth – Photon Storm guys released a Box2D plugin for Phaser.

It’s time to publish some tutorials about it, and we start with the most basic tutorial, that is a “click to create, click to remove” script.

This is what I mean:

Click anywhere, you will create a crate if you click on an empty spot, or destroy a crate if you click on it.

The code is very easy to understand, as unlike the original Box2D and its AS3 porting, where it’s up to you to add sprites and synchronize them with physics world bodies, Phaser works in the opposite way: you add the sprites and assign a body to them.

Way more intuitive, and you won’t need the debug draw tool that much.

Here is the code:

var game;

window.onload = function() {	
	game = new Phaser.Game(640, 480, Phaser.AUTO, "");
     game.state.add("PlayGame",playGame);
     game.state.start("PlayGame");
}
	
var playGame = function(game){};

playGame.prototype = {
	preload: function(){
		game.load.image("crate", "crate.png");
		game.load.image("ground", "ground.png"); 
	},
  	create: function(){
  		game.stage.backgroundColor = "#222222";
  		// in the same way we initialized other Phaser physics engines, this is how we initialize Box2D engine
		game.physics.startSystem(Phaser.Physics.BOX2D);
		// setting gravity
		game.physics.box2d.gravity.y = 500;
		// we add the sprite which will represent the ground.
		// notice are placing it as if the registration point were in the center
    		var groundSprite = game.add.sprite(320, 460, "ground");
    		// enabling the physics on the body
    		game.physics.box2d.enable(groundSprite);
    		// making the body/sprite static
    		groundSprite.body.static = true;
    		// waiting for player input
    		game.input.onDown.add(addCrate, this);
	}
}

function addCrate(e){
	// this is how we get an array of bodies at a certain cordinate, in this case player input coordinate
	var currentBody = game.physics.box2d.getBodiesAtPoint(e.x, e.y);
	// if there is at least one body (but it can't be more than one in this example)...
	if(currentBody.length>0){	
		// if the body is not static (it's not the ground)
		if(!currentBody[0].static){
			// destroy the sprite and the body
			currentBody[0].sprite.destroy();
		}
	}
	else{
		// otherwise create a crate in the same way we created the ground
		var crateSprite = game.add.sprite(e.x, e.y, "crate");
    		game.physics.box2d.enable(crateSprite);
    	}
}

This plugin is really awesome, so expect more tutorials and some games during next weeks. Mwanwhile, you can download the source code.

Get the most popular Phaser 3 book

Through 202 pages, 32 source code examples and an Android Studio project you will learn how to build cross platform HTML5 games and create a complete game along the way.

Get the book

214 GAME PROTOTYPES EXPLAINED WITH SOURCE CODE
// 1+2=3
// 100 rounds
// 10000000
// 2 Cars
// 2048
// A Blocky Christmas
// A Jumping Block
// A Life of Logic
// Angry Birds
// Angry Birds Space
// Artillery
// Astro-PANIC!
// Avoider
// Back to Square One
// Ball Game
// Ball vs Ball
// Ball: Revamped
// Balloon Invasion
// BallPusher
// Ballz
// Bar Balance
// Bejeweled
// Biggification
// Block it
// Blockage
// Bloons
// Boids
// Bombuzal
// Boom Dots
// Bouncing Ball
// Bouncing Ball 2
// Bouncy Light
// BoxHead
// Breakout
// Bricks
// Bubble Chaos
// Bubbles 2
// Card Game
// Castle Ramble
// Chronotron
// Circle Chain
// Circle Path
// Circle Race
// Circular endless runner
// Cirplosion
// CLOCKS - The Game
// Color Hit
// Color Jump
// ColorFill
// Columns
// Concentration
// Crossy Road
// Crush the Castle
// Cube Jump
// CubesOut
// Dash N Blast
// Dashy Panda
// Deflection
// Diamond Digger Saga
// Don't touch the spikes
// Dots
// Down The Mountain
// Drag and Match
// Draw Game
// Drop Wizard
// DROP'd
// Dudeski
// Dungeon Raid
// Educational Game
// Elasticity
// Endless Runner
// Erase Box
// Eskiv
// Farm Heroes Saga
// Filler
// Flappy Bird
// Fling
// Flipping Legend
// Floaty Light
// Fuse Ballz
// GearTaker
// Gem Sweeper
// Globe
// Goat Rider
// Gold Miner
// Grindstone
// GuessNext
// Helicopter
// Hero Emblems
// Hero Slide
// Hexagonal Tiles
// HookPod
// Hop Hop Hop Underwater
// Horizontal Endless Runner
// Hundreds
// Hungry Hero
// Hurry it's Christmas
// InkTd
// Iromeku
// Jet Set Willy
// Jigsaw Game
// Knife Hit
// Knightfall
// Legends of Runeterra
// Lep's World
// Line Rider
// Lumines
// Magick
// MagOrMin
// Mass Attack
// Math Game
// Maze
// Meeblings
// Memdot
// Metro Siberia Underground
// Mike Dangers
// Mikey Hooks
// Nano War
// Nodes
// o:anquan
// One Button Game
// One Tap RPG
// Ononmin
// Pacco
// Perfect Square!
// Perfectionism
// Phyballs
// Pixel Purge
// PixelField
// Planet Revenge
// Plants Vs Zombies
// Platform
// Platform game
// Plus+Plus
// Pocket Snap
// Poker
// Pool
// Pop the Lock
// Pop to Save
// Poux
// Pudi
// Pumpkin Story
// Puppet Bird
// Pyramids of Ra
// qomp
// Quick Switch
// Racing
// Radical
// Rebuild Chile
// Renju
// Rise Above
// Risky Road
// Roguelike
// Roly Poly
// Run Around
// Rush Hour
// SameGame
// SamePhysics
// Save the Totem
// Security
// Serious Scramblers
// Shrink it
// Sling
// Slingy
// Snowflakes
// Sokoban
// Space Checkers
// Space is Key
// Spellfall
// Spinny Gun
// Splitter
// Spring Ninja
// Sproing
// Stabilize!
// Stack
// Stick Hero
// String Avoider
// Stringy
// Sudoku
// Super Mario Bros
// Surfingers
// Survival Horror
// Talesworth Adventure
// Tetris
// The Impossible Line
// The Moops - Combos of Joy
// The Next Arrow
// Threes
// Tic Tac Toe
// Timberman
// Tiny Wings
// Tipsy Tower
// Toony
// Totem Destroyer
// Tower Defense
// Trick Shot
// Tunnelball
// Turn
// Turnellio
// TwinSpin
// vvvvvv
// Warp Shift
// Way of an Idea
// Whack a Creep
// Wheel of Fortune
// Where's my Water
// Wish Upon a Star
// Word Game
// Wordle
// Worms
// Yanga
// Yeah Bunny
// Zhed
// zNumbers