https://github.com/egamagz/paska-ovo

A simple javascript library for adding easter eggs to web pages 🥚
https://github.com/egamagz/paska-ovo

bun deno easter-egg javascript jsr nodejs typescript

Last synced: about 2 months ago
JSON representation

A simple javascript library for adding easter eggs to web pages 🥚

• Host: GitHub
• URL: https://github.com/egamagz/paska-ovo
• Owner: EGAMAGZ
• License: mit
• Created: 2024-04-17T03:19:17.000Z (9 months ago)
• Default Branch: master
• Last Pushed: 2024-11-19T03:46:51.000Z (about 2 months ago)
• Last Synced: 2024-11-19T04:29:38.019Z (about 2 months ago)
• Topics: bun, deno, easter-egg, javascript, jsr, nodejs, typescript
• Language: TypeScript
• Homepage: https://egamagz.github.io/paska-ovo/
• Size: 564 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Paska Ovo

![Paska](./img/paska-logo.png)

A simple javascript library for adding easter eggs to web pages

[![JSR](https://jsr.io/badges/@egamagz/paska-ovo)](https://jsr.io/@egamagz/paska-ovo)

[![JSR Score](https://jsr.io/badges/@egamagz/paska-ovo/score)](https://jsr.io/@egamagz/paska-ovo/score)

![GitHub License](https://img.shields.io/github/license/egamagz/paska-ovo)

![GitHub Release](https://img.shields.io/github/v/release/egamagz/paska-ovo)

## Installation

### For Deno

```bash

deno add @egamagz/paska-ovo

```

### For Node.js

```bash

npx jsr add @egamagz/paska-ovo

```

### For Bun

```bash

bunx jsr add @egamagz/paska-ovo

```

### For other package managers

Check the [JSR page for more details](https://jsr.io/@egamagz/paska-ovo).

## Example

```typescript

import { HistoricalCodes, PaskaOvo } from "@egamagz/paska-ovo";

const paskaOvo = new PaskaOvo()

  .addEasterEgg({

    code: HistoricalCodes.BarrelRoll,

    onFound: () => {

      //...

    },

    onFinish() {

      // ...

    },

    duration: 1000,

    tag: "Barrel Roll"

  })

  .addEasterEgg({

    code: HistoricalCodes.Konami,

    onFound: () => {

      // ...

    },

    tag: "Konami"

  })

  .addEasterEgg({

    code: ["a", "w", "e", "s", "o", "m", "e"],

    onFound: () => {

      // ...

    },

    tag: "Awesome"

  })

  .addCallback((easterEgg) => {

    alert(`You found the easter egg: ${easterEgg.tag}`)

  });

// Listen to keyboard events

document.getElementById("add-easter-egg").addEventListener("click", () => {

  paskaOvo.listen();

});

// Stop listening to keyboard events

document

  .getElementById("remove-easter-egg")

  .addEventListener("click", () => {

    paskaOvo.stop();

  });

```

Alternatively, it's possible to define the easter egg using the constructor:

```typescript

import { HistoricalCodes, PaskaOvo } from "@egamagz/paska-ovo";

 const paskaOvo = new PaskaOvo({

  code: HistoricalCodes.Konami,

  onFound: () => {

   alert("Gradius");

  },

  tag: "konami-code",

 }).addCallback((easterEgg) => {

  console.log("Actual easter egg:", easterEgg.tag);

  console.log("Easter egg's code:", easterEgg.code);

 });

 paskaOvo.listen();

```

Check the [example](https://egamagz.github.io/paska-ovo/) with [source code](https://github.com/EGAMAGZ/paska-ovo/tree/master/example).

## Credits

Inspired by the project [Egg.js](https://github.com/mikeflynn/egg.js) and [La Velada Web](https://github.com/midudev/la-velada-web-oficial). Created by [EGAMAGZ](https://github.com/EGAMAGZ).

## License

MIT License