Skip to content

Latest commit

 

History

History
105 lines (81 loc) · 2.4 KB

README.md

File metadata and controls

105 lines (81 loc) · 2.4 KB

👾🥕 Alien Food Invasion

Latest Version on NPM Total Downloads on NPM Software License

Alien Food Invasion

If you are looking for an easy game for example when the Browser is offline and the User needs to wait, this package is for you. 😜

Installation in 2 Steps*

1: Install the package 💻 on NPM

npm i foodinvasion

2: Add the package in your main.js

import { startPlaying, removeGame } from 'foodinvasion';

...
startPlaying();

//after game is done and you need to remove the listeners
removeGame();

💪 How to use it

Somewhere you html/vue/react and so on you need this:

<div id="game-container">
    <canvas
        id="game"
        width="320"
        height="480"
    />
</div>

Example in Vue:

<template>
    <div>
        <div id="game-container">
            <transition name="tvScale">
                <canvas
                    v-show="showGame"
                    id="game"
                    width="320"
                    height="480"
                    />
            </transition>
        </div>
        <div>
            <button class="btn" type="button" @click="playGame">Play</button>
        </div>
    </div>

</template>
<script>
import { startPlaying, removeGame } from 'foodinvasion';

export default {
    data() {
        return {
            showGame: false,
        };
    },
    methods: {
        playGame() {
            this.setShowGame();

            // tv animation takes some time
            setTimeout(() => {
                startPlaying();
            }, 401);
        },
        setShowGame() {
            this.showGame = true;
        },
    },
    beforeDestroy() {
        removeGame();
    }
};
</script>

Security

If you discover any security related issues, please don't email me. I'm afraid 😱. [email protected]

Credits

Now comes the best part! 😍

Oh come on. You read everything?? If you liked it so far, hit the ⭐️ button to give me a 🤩 face.