README.md

Picture Puzzle

Picture Puzzle a browser based game made of tiles. Each tile consists of a section of an picture. To solve the puzzle, you have to arrange the tiles such that the picture is displayed correctly.

Installation requirements.

• Node.js (The latest stable version)
• Yarn
• Gulp

NOTE: You can use npm if you prefer it to yarn.

How to run the game in development mode.

Clone the repo.

git clone https://github.com/john555/picture-puzzle.git
cd picture-puzzle

Run the app.

$ yarn start

Or

$ npm start # or npm run start

Documentation.

In order to integrate the game to your website or web app, include the dist/puzzle.js file in your HTML document.

<div id="game"></div>
<script src="/path/to/dist/puzzle.js"></script>

Create the game.

const game = new Puzzle({
  tileSize: 100, // width and height of the tile
  columns: 4,
  rows: 4,
  difficulty: 4,
  scale: 0.996, // Determines the scale of the tiles. As scale value less than 1 reveals gridlines
  image: {
    url: '/url/or/path/to/image',
    preserve: 'width', //['width', 'height'] the width or height will be preserved
    offset: 0,
  },
});

Render the game.

game.render('game');

Start the game.

game.start();

Events

onSolve() - Do something when the puzzle is solved.

game.onSolve(function(event) {
  alert(`You solved the puzzle in ${event.time}s`);
});

onTimeUpdate() - You can get update the timer during the course of the game.

game.onTimeUpdate(function(event) {
  const time = event.time;
});