A simple puzzle game using Phaser js
JavaScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
css
docs
js
.gitignore
Makefile
README.md
app.js
build.js
index.html

README.md

Quad

Quad is a puzzle game written using Phaser. The game may be played in a web browser here, or by cloning the repository and executing python -m http.server (or equivalent) from the project root.

How To Play

Groups of four colored blocks (known as quads) will fall from the top of the screen, onto the game grid below. Create groups of blocks of the same color by rotating the direction from which the quad is falling (with the left and right arrows), or by shifting the contents of the grid (with WASD). When the player makes a square of blocks of the same color, that group will clear, as well as any adjacent blocks of the same color. Clear blocks to earn points! Be sure to not let the quad fall outside the game grid though, or its 'Game Over'.

Controls

Key Action
Left/Right Rotate the waiting quad
W/A/S/D Shift the contents of the game grid
P Pause/Unpause the game
Space Manually drop the waiting quad

TODO

  • define and display grid
  • define quad (group of 4 blocks)
  • allow clearing of blocks
  • allow shifting of blocks
  • sounds
  • score/level system
  • graphics (possibly sprites for blocks)
  • rest of page HTML

Documentation

Documentation is generated with JSDoc and may be found here. It may be built by installing jsdoc and the theme npm install jsdoc ink-docstrap. Build the docs with make docs in the project root. The generated documentation will be placed in 'docs/html'.

Attributions

  • Sound for blocks landing from junggle (unmodified).
  • Sound for block destruction from Sergenious (unmodified)
  • Sound for rotation of blocks from MissCellany (unmodified)
  • Sound for grid movement from Greencouch (converted to wav).
  • Background music by DST available at nosoapradio (unmodified).