Git Product home page Git Product logo

pong.js's Introduction

pong.js

Pong game powered by JavaScript. :)

Introduction

Pong.js is a simple JavaScript library to let you add a custom pong game on your web applications. Just set up some basic option and let the library do the job.

A <canvas> tag moved by requestAnimationFrame will be append on our document and the game will begin.

To move the paddle we can use the keybord arrows, to start the game just press ENTER and to pause the game push the space bar. We can start a new game or change the level game using the menu.

How it works?

  • First step, include the pong.js file in your web project. The best place to put it is inside your <head> tag.
<script src="[PATH_TO_JS_FOLDER]/pong.js"></script>
  • Create a new PongGame istance and give it your favourite options to customize it:
var pongGame = new PongGame({
	level: 2,
   	width: 600,
	height: 600,
});
  • Finally, let's initialize it!
pongGame.init();

Options

Name Type Default values Description
width integer window.innerWidth Set the width of canvas in pixels.
height integer window.innerHeight Set the height of canvas in pixels.
level integer 1 Set the difficult of the game. Values: 1 to 5
background color '#000000' Set the background color of the canvas.
field object {
'background' : '#000000',
'color' : '#FFFFFF'
}
Object that define custom setting for the field of the pong game.
paddle object {
'width': 50,
'height': 10,
'color': '#FFFFFF'
}
Object that define custom setting for the paddles of the pong game.
ball object {
'radius': 5,
'color': '#FFFFFF'
}
Object that define custom setting for the ball of the pong game.
theme string null Set the theme of the pong game. You can choose beetween 'dark', 'light' and 'matrix'. If you choose a theme, it overrides the colors settings seen before.
onInit function null Callback function called the first time the game is initialized and ready to play.
onPlay function null Callback function called everytime the game is playing.
onPause function null Callback function called everytime the game is paused.

To do list - (work in progress)

  • Utility callbacks
  • Additional public methods like reInit, newGame, pause, update, etc..
  • Polish

License

MIT License

Copyright (c) 2017 Daniele Petrarolo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pong.js's People

Contributors

danielepetrarolo avatar

Watchers

James Cloos avatar Petar Slovic avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.