Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/namuol/cheet.js
easy easter eggs (konami code, etc) for your website.
https://github.com/namuol/cheet.js
Last synced: 15 days ago
JSON representation
easy easter eggs (konami code, etc) for your website.
- Host: GitHub
- URL: https://github.com/namuol/cheet.js
- Owner: namuol
- License: mit
- Created: 2013-11-02T02:04:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T01:38:58.000Z (over 3 years ago)
- Last Synced: 2024-05-10T15:03:54.055Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://lou.wtf/cheet.js
- Size: 319 KB
- Stars: 1,327
- Watchers: 28
- Forks: 80
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - namuol/cheet.js - easy easter eggs (konami code, etc) for your website. (JavaScript)
- awesome-stars - namuol/cheet.js - easy easter eggs (konami code, etc) for your website. (JavaScript)
- awesome-stars - cheet.js
README
# cheet.js [](https://drone.io/github.com/namuol/cheet.js/latest) [](https://david-dm.org/namuol/cheet.js#info=devDependencies) [](https://david-dm.org/namuol/cheet.js#info=devDependencies)
## easy easter eggs in the browser
```javascript
cheet('↑ ↑ ↓ ↓ ← → ← → b a', function () { alert('Voilà!'); });
```
```javascript
cheet('i d d q d', function () {
alert('god mode enabled');
});
```
```javascript
cheet('o n e a t a t i m e', {
next: function (str, key, num, seq) {
console.log('key pressed: ' + key);
console.log('progress: ' + num / seq.length);
console.log('seq: ' + seq.join(' '));
},
fail: function () {
console.log('sequence failed');
},
done: function () {
console.log('+30 lives ;)');
}
});
```
```javascript
cheet('o n c e', function () {
console.log('This will only fire once.');
cheet.disable('o n c e');
});
```
```javascript
var sequences = {
cross: 'up down left right',
circle: 'left up right down'
};
cheet(sequences.cross);
cheet(sequences.circle);
cheet.done(function (seq) {
if (seq === sequences.cross) {
console.log('cross!');
} else {
console.log('circle!');
}
});
```
### Demo
[My personal site](http://namuol.github.io) uses cheet.js (Try the [Konami Code](http://en.wikipedia.org/wiki/Konami_Code))
### Install
#### Easy CDN
(Awesome free OSS hosting provided by [@rgrove](http://github.com/rgrove) via [rawgit](http://rawgit.com))
#### bower
bower install cheet.js
#### component
component install namuol/cheet.js
### API
#### [`cheet(sequence, done | {next,fail,done})`](#api_cheet)
Map a sequence of keypresses to a callback. This can be called multiple times.
>
> [`sequence`](#api_cheet_sequence) (String)
> > A string representation of a sequence of [key names](#available-key-names).
> >
> > Each keyname must be separated by a single space.
>
>
> [`done(str, seq)`](#api_cheet_done) (callback)
> > A callback to execute each time the sequence is correctly pressed.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that completed.
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that completed.
>
>
> [`fail(str, seq)`](#api_cheet_fail) (callback)
> > A callback to execute each time a sequence's progress is broken.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that failed.
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that was pressed.
>
>
> [`next(str, key, num, seq)`](#api_cheet_next) (callback)
> > A callback to execute each time a correct key in the sequence is pressed *in order*.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that is in progress.
> > * `key` - The [name of the key](#available-key-names) that was just pressed.
> > * `num` - A number representing the current progress of the sequence. (starts at 0)
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that is in progress.
#### [`cheet.done(callback)`](#api_done)
Set a global callback that executes whenever *any* mapped sequence is completed successfully.
>
> [`callback(str, seq)`](#api_done_callback) (callback)
> > A callback to execute each time *any* sequence is correctly pressed.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that completed.
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that completed.
#### [`cheet.next(callback)`](#api_next)
Set a global callback that executes whenever *any* mapped sequence progresses.
>
> [`callback(str, key, num, seq)`](#api_next_callback) (callback)
> > A callback to execute each time a correct key in any sequence is pressed *in order*.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that is in progress.
> > * `key` - The [name of the key](#available-key-names) that was just pressed.
> > * `num` - A number representing the current progress of the sequence. (starts at 0)
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that is in progress.
#### [`cheet.fail(callback)`](#api_fail)
Set a global callback that executes whenever *any* in-progress sequence is broken.
>
> [`callback(str, seq)`](#api_fail_callback) (callback)
> > A callback to execute each time *any* sequence's progress is broken.
> >
> > Arguments:
> > * `str` - The string representation of the sequence that failed.
> > * `seq` - An array of [key names](#available-key-names) representing the sequence that was pressed.
#### [`cheet.disable(sequence)`](#api_disable)
Disable a previously-mapped sequence.
>
> [`sequence`](#api_disable_sequence) (String)
> > The same string you used to map the callback when using [`cheet(seq, ...)`](#api_cheet).
#### [`cheet.reset(sequence)`](#api_reset)
Resets a sequence that may or may not be in progress.
This will *not* cause `fail` callbacks to fire, but will effectively
cancel the sequence.
>
> [`sequence`](#api_reset_sequence) (String)
> > The same string you used to map the callback when using [`cheet(seq, ...)`](#api_cheet).
### Available Key Names
**NOTE**: Key names are case-sensitive
#### Directionals
* `left` | `L` | `←`
* `up` | `U` | `↑`
* `right` | `R` | `→`
* `down` | `D` | `↓`
#### Alphanumeric
* `0`-`9` (main number keys)
* `a`-`z`
#### Misc
* `backspace`
* `tab`
* `enter` | `return`
* `shift` | `⇧`
* `control` | `ctrl` | `⌃`
* `alt` | `option` | `⌥`
* `command` | `⌘`
* `pause`
* `capslock`
* `esc`
* `space`
* `pageup`
* `pagedown`
* `end`
* `home`
* `insert`
* `delete`
* `equal` | `=`
* `comma` | `,`
* `minus` | `-`
* `period` | `.`
#### Keypad
* `kp_0`-`kp_9`
* `kp_multiply`
* `kp_plus`
* `kp_minus`
* `kp_decimal`
* `kp_divide`
#### Function keys
* `f1`-`f12`
### License
MIT
### Testing
From the cheet.js' root directory:
```shell
grunt test
```
You can also run the tests directly in your browser:
```shell
grunt test.open
```
Or just [view them online](http://namuol.github.io/cheet.js/tests).
### Acknowledgements
Special thanks to [Guilherme J. Tramontina](http://github.com/gtramontina) for writing the delicious [mocha](http://mochajs.org/)/[chai](http://chaijs.com/) test suite.
---
`cheet.js` was just a fun little one-night project I made to put easter eggs on my personal site.
If you're looking for something more useful/serious, check out [Mousetrap](https://github.com/ccampbell/mousetrap).
---
[](https://github.com/igrigorik/ga-beacon)