Skip to content
3D web-based maze game using three.js
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
js
public_html
spec Add Jasmine unit tests for Maze Dec 25, 2016
.eslintrc.js
.gitignore Change jsdoc output directory to doc, add it to .gitignore Dec 7, 2016
LICENSE
README.md Add note about tests to README.md Dec 25, 2016
package.json Add -r flag to jsdoc script Dec 25, 2016

README.md

Corridors.io

Standard - JavaScript Style Guide license Website

Generates a maze using a randomized depth first search algorithm and turns it into a 3d maze using three.js. The user is placed in the upper left hand corner of the maze and must try to find his/her way to the bottom right hand corner of the maze, which is marked by a hole in the wall.

Controls

  • WASD / Arrow keys - Move
  • Mouse - Adjust yaw / look

Building

Ensure that you have npm installed and run:

npm install

Then run:

npm run build-dev

This will bundle all the js and put it in public_html/game.js. After you have game.js, just open public_html/index.html in a web browser.

To bundle all the js and minify it, run:

npm run build-release

Tests

Jasmine unit tests are located in the spec directory. To run them, use:

npm test

Documentation

This project uses JSDoc.

To generate HTML from JSDoc comments, use:

npm run doc

This will output all documentation in the doc directory.

Style

This project uses the JS standard code style.

To run eslint, use:

npm run lint

License

All code licensed under the MIT license (See LICENSE file). All images licensed under CC0 / Public domain.

Todo

  • Add more maze generators
  • Add a page allowing the user to select a maze generator / maze size
  • Document everything
You can’t perform that action at this time.