Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 3.29 KB

README.md

File metadata and controls

79 lines (60 loc) · 3.29 KB
Raw

Tetris.js

A Tetris clone for HTML5

The game is hosted at http://cbarrick.github.io/Tetris.js/

Annotated source code documentation is here.

This game was created as a project for CSCI 4070 - Game Programming at the University of Georgia. The required report has been rendered to HTML as the index page of the documentation. To run the code from the repository, open index.xhtml in a browser. To run the unit tests, open test/index.xhtml.

Source layout

The source has a very standard layout. Part of the requirement was that we use no 3rd party libraries. However, I used Require.js for code modularization and Mocha and Chai for unit testing, and more recently I have introduced a pollyfill to normalize keycodes across browsers. The logic of the game itself is entirely my own.

├── LICENSE
├── README.md
├── index.xhtml
├── main.js
├── assets
│   └── { Assets needed by the XHTML page }
├── docs
│   └── { Generated documentation }
├── lib
│   └── { Dev tools needed at run-time }
├── src
│   └── { The source logic for the game }
└── test
    ├── lib
    │   └── { Dev tools needed at test-time }
    ├── index.xhtml
    └── { The unit tests for the lower level classes }

Unit Testing

Unit tests are written with Mocha and Chai. The tests only cover the lower-level classes. To run them, open test/index.xhtml in a browser.

Credits

Development tools

  • Docco: A quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.
  • Require.js: A file and module loader for JavaScript.
  • Mocha: A simple, flexible, fun javascript test framework for node.js & the browser.
  • Chai: A BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.

License

Copyright (C) 2014 Chris Barrick (cbarrick1@gmail.com)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.