https://github.com/caiogondim/js-konami-code-event
Konami code event for your HTML5 web app/page
https://github.com/caiogondim/js-konami-code-event
Last synced: 3 days ago
JSON representation
Konami code event for your HTML5 web app/page
- Host: GitHub
- URL: https://github.com/caiogondim/js-konami-code-event
- Owner: caiogondim
- Created: 2013-08-18T07:40:57.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-12-18T18:11:58.000Z (over 11 years ago)
- Last Synced: 2025-05-18T14:09:40.427Z (28 days ago)
- Language: JavaScript
- Homepage: http://caiogondim.github.io/js-konami-code-event/
- Size: 1.88 MB
- Stars: 40
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Konami code [](https://travis-ci.org/caiogondim/js-konami-code-event) [](http://gruntjs.com/)
The Konami Code (Japanese: コナミコマンド, Konami komando, "Konami command") is a
cheat code that appears in many Konami video games, although the code also
appears in some non-Konami games.
During the title screen before the game demo begins, the player could press the
following sequence of buttons on the game controller to enable the cheat:
⬆ ⬆ ⬇ ⬇ ⬅ ➡ ⬅ ➡ B A
You can see a demo [here](http://caiogondim.github.io/js-konami-code-event/)
# How to install
You can install through _Bower_
```bash
bower install konami-code-event
```
Or just download the minified JS file through this
[link](https://raw.github.com/caiogondim/js-konami-code-event/master/src/konami-code.min.js)
# How to use
Load the script in your web app/site and listen for the event `konamiCode` in
your document:
```javascript
document.addEventListener('konamiCode', function(event) {
// code executed whenever the user types a konami code
})
```
It can also be used along with jQuery:
```javascript
$(document).on('konamiCode', function(event) {
// code executed whenever the user types a konami code
})
```
Type this sequence **⬆ ⬆ ⬇ ⬇ ⬅ ➡ ⬅ ➡ B A** to trigger the event.
# How to contribute
1. Fork this repository
2. Run `npm install`
3. Create a new branch for each feature or improvement
4. Ensure that your code is accompanied with tests
5. Run `grunt test` to ensure that your new tests and the old ones are all passing
6. Send a pull request from each feature branch
# License
Copyright © 2013 [Caio Gondim](http://caiogondim.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the “Software”), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.