npm

flappysonic-client

0.0.8 • Public • Published

flappysonic-client Tag Build Status Test Coverage Maintainability

Instructions

This is the client part of a Flappy Bird Like game featuring Sonic the Hedgehog.

Requeriments

  • This has createjs as an external dependency, this library has not been bundled.

Installation

You can get the package from npm with npm i flappysonic-client

You can also build it from surce cloning the project, navigate to its root folder and execute npm install for installing it's dependencies, and then npm run-script build for building it.

Usage

To embed this game in an html file createjs has to be loaded from its CDN first, then you can load bundle.js and the canvas where the game will be inserted like:

<html>
    <head>
      <script src="https://code.createjs.com/1.0.0/createjs.min.js" />
      <script src="/scripts/bundle.js"/>
    </head>
    <body>
      <canvas id="gameCanvas" width="320" height="288" />
    </body>
</html>

I recommend checking as an example the official backend.

Testing

For executing the tests just execute npm test on the project's root folder.

Contributing

Any suggestion, bug reports, or any other kind enhacements are welcome. Just open an issue first for creating a PR remember this project has linting checkings so any PR should comply with them before beign merged, this checks will be automatically applied when opening or modifying the PR's.

Readme

Keywords

none

Package Sidebar

Install

npm i flappysonic-client

Weekly Downloads

3

Version

0.0.8

License

MIT

Unpacked Size

50.4 kB

Total Files

4

Last publish

Collaborators

  • namelivia