Skip to content

KevinHerklotz/eastereck

Repository files navigation

eastereck

You like to amaze or annoy users of your website with funny easter eggs? Then this repository is what you need! It provides a lot of easter eggs and a simple API.

If you have more ideas, tell me!

Notice that it is still in development.

Demo

Click here to see a demo page.

Include it into your project

Via npm

The aim is to install it via npm with npm install eastereck --save-dev and then just require or import it. This is not supported yet, but it's coming soon.

var eastereck = require('eastereck');

Via script tag

An other way is to include it via script tag in HTML:

<script src="https://github.com/KevinHerklotz/eastereck/dist/eastereck.min.js"></script>

This adds the eastereck object to the global scope, so you can start an easter egg with eastereck.eastereggname.start().

And yes, everything (images, sounds, style, ...) is already included in this one JavaScript file.

// Example:
<button onclick="eastereck.unicorncursor.start()">change cursor</button>

Usage

// To start it
eastereck.functionname.start(duration, callback);

// To stop it
eastereck.functionname.stop();

The function start() accepts two parameters. Both are optional:

  1. duration - time in milliseconds before stop() function is triggered, default is 0 which means that stop() function is never triggered automatically
  2. callback - function that will be executed after the duration triggered the stop() function
// Example:
eastereck.upsidedown.start(2000, function() {
    alert('That was just a joke.');
});

Available easter eggs

Already implemented

(alphabetical order)

drunken

Blurred screen like when you are drunken. Takes 5 seconds till it gets 100% blurred.

Does not work in IE (see caniuse.com).

iconparty

If you use icon fonts on your website, they start to dance, rotate or jump.

Effected icons are elements that match the following selector: '.fa, .material-icons, .glyphicon, .icon, .octicon, .mega-octicon, .typcn'.

neonflicker

Alternating neon colors that will make your eyes bleed.

pornsound

An embarrassing porn sound is played.

shaking

Website is moving around.

unicorncursor

Cursor turns into unicorn.

upsidedown

Screen will rotate 180 degree and an upside down cursor is shown (can be overwritten by "unicorncursor"). Most funny on mobile devices, when the user tries to rotate the device to solve the problem.

Doesn't work if "shaking" is active.

Ideas / not yet implemented

brokenglass

You think you broke your screen glass! Even with the sound of breaking glass.

flicker

Screen will flicker like an old television.

meancaptcha

Displays a very mean Captcha.

scrollconfusion

Scrolling up will scroll down the page and vice versa.

unicorninvasion

Unicorns appear all over the screen and a fancy unicorn song is played.

About

A library that provides funny easter eggs for your website

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published