Skip to content

callmenick/Memory

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Memory Game

Memory game is a game built for fun, using HTML, CSS, and JavaScript. The objective of Memory is to flip and match all the turned-down cards in as few moves as possible.

The game itself built entirely with JavaScript, so you can just drop it into your site / app into any element you like. The making of this game was inspired by this pen, but I went about it using plain JS, and making 3 different levels. Because it's all front end tech in action, it should work across all devices, tablets, etc.

Demo

A working demo can be seen here - http://callmenick.com/memory/

Usage

Usage is easy. Just markup the div you want Memory to exist in, and create a new instance of Memory.

<div id=""my-memory-game"></div>

<script src="path/to/memory.js"></script>
<script>
  var myMem = new Memory({
    wrapperID : "my-memory-game",
  });
</script>

Options

Memory ships with 4 options. They are:

  1. wrapperID - the ID of the div you want to attach Memory to
  2. cards - the array of cards to use during Memory. More on this below.
  3. onGameStart - a callback function that runs once the game starts, i.e. once a user clicks on a level.
  4. onGameEnd - a callback function that runs once the game ends. More on this below.

Defaults

The default options for Memory are as follows:

wrapperID : "my-memory-game",
cards : [
  {
    id : 1,
    img: "img/default/monsters-01.png"
  },
  {
    id : 2,
    img: "img/default/monsters-02.png"
  },
  {
    id : 3,
    img: "img/default/monsters-03.png"
  },
  {
    id : 4,
    img: "img/default/monsters-04.png"
  },
  {
    id : 5,
    img: "img/default/monsters-05.png"
  },
  {
    id : 6,
    img: "img/default/monsters-06.png"
  },
  {
    id : 7,
    img: "img/default/monsters-07.png"
  },
  {
    id : 8,
    img: "img/default/monsters-08.png"
  },
  {
    id : 9,
    img: "img/default/monsters-09.png"
  },
  {
    id : 10,
    img: "img/default/monsters-10.png"
  },
  {
    id : 11,
    img: "img/default/monsters-11.png"
  },
  {
    id : 12,
    img: "img/default/monsters-12.png"
  },
  {
    id : 13,
    img: "img/default/monsters-13.png"
  },
  {
    id : 14,
    img: "img/default/monsters-14.png"
  },
  {
    id : 15,
    img: "img/default/monsters-15.png"
  },
  {
    id : 16,
    img: "img/default/monsters-16.png"
  }
],
onGameStart : function() { return false; },
onGameEnd : function() { return false; }

The Cards

Right now, Memory's biggest game size is a 8 x 4 grid, meaning 32 cards. Therefore, users must specify 16 cards with unique id's and image paths in order for Memory to run at all three levels. If you don't specify any cards in the new instance of Memory, the default set will be used.

onGameEnd Callback

The onGameEnd callback gets triggered when the game has ended. If you don't specify a callback (i.e. the callback defaults to returns false), then when the game has ended, a default operation occurs. The board is cleared, and the user is presented with a "win" screen showing how many moves they completed the game in, and a button to start over.

Public Functions

There is one "public" function available for you to use, and that is resetGame. It basically clears the board and resets all variables, taking you back to the start screen. You can use it like this:

var myMem = new Memory;
myMem.resetGame();

Sass

Sass was used quite a lot, as well as some related libraries like Auto Prefixer and Sassy Math. I also use Compass. In order for the Sass files to run as is, take a look at the compass config.rb file and make sure you have everything set up! Otherwise, plain old CSS for you.

Support

Memory has been tested in the following browsers:

  • Chrome - 37
  • Firefox - 32
  • Safari - 7

Anyone who conducts tests and gets positive or negative results, please let me know!

External Libs

I used the classList property a bit throughout the script, and you can read more documentation on that here. Because of poor IE support though (10 and up), I made sure to include the classList polyfill, which you can find here.

License

Licensed under the MIT license - http://www.opensource.org/licenses/mit-license.php

About

A memory game.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published