Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jeremija/snake
Classic snake game written in javascript
https://github.com/jeremija/snake
Last synced: 9 days ago
JSON representation
Classic snake game written in javascript
- Host: GitHub
- URL: https://github.com/jeremija/snake
- Owner: jeremija
- Created: 2014-02-14T20:06:39.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-14T17:38:23.000Z (over 8 years ago)
- Last Synced: 2024-04-14T19:48:36.415Z (7 months ago)
- Language: JavaScript
- Homepage: http://steinerize.com/snake
- Size: 121 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Snake
=====
Classic snake game written in JavaScript. Uses [knockout.js](http://knockoutjs.com) and [require.js](http://requirejs.org). Also uses [Hammer.js](http://eightmedia.github.io/hammer.js/) for gestures on devices with touchscreens.
Click [here to try it](http://steiner.website/snake). Use arrow keys to move if you are on a desktop computer, or swipe gestures if you are on a mobile device.
Features
--------
* Retro look
* Control the snake with arrow keys, mouse, or swipe gestures
* Hotkeys for every command:
* `F1` for displaying about and help information
* `F2` for restarting the game
* `F3` for configuring and starting a custom game and
* `P` for pause
Tested on
---------
* Chrome 32, Firefox 27 on Ubuntu 13.10
* IE9 on Windows 7
* Chrome 32, Browser (Chrome 30) on Android 4.4 (Nexus 4)
* Chrome 32 on iOS 6 (iPhone 4)
Cloning and setting up
----------------------
Prerequisites: [npm](https://www.npmjs.org/) and [bower](http://bower.io/) installed globally or their location must be added to the `$PATH` environment variable.
```bash
# clone the repository
git clone https://github.com/jeremija/snake.git
cd snake
# install bower and npm dependencies
bower install
npm install
# start the server
make server
```
Now you should be able to navigate to [http://localhost:8080/src/index.html](http://localhost:8080/src/index.html) in your browser.
Testing
-------
Follow the setting up guide, open your browser and navigate to [http://localhost:8080/test/test.html](http://localhost:8080/test/test.html).
You can also run the tests by typing `make test`. This will use [mocha-phantomjs](https://www.npmjs.org/package/mocha-phantomjs) as the test runner.
Building
--------
```bash
# install dependencies if not already
npm install
bower install
# initiate build
make
```
and a `./dist` folder should be created.
If you wish to build the documentation, run:
```bash
make docs
```
This should create a new folder: `./docs`.
License
-------
MIT license.