Skip to content

Complete nodegame repository with examples and documentation

Notifications You must be signed in to change notification settings

bogdanstate/nodegame

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nodeGame

nodeGame is a free, open source, event-driven javascript framework for online, multiplayer games in the browser.


nodeGame is a general framework to play any kind of game online, but it specially designed to conduct social experiments.

The Good parts

  • Open source and open standard (HTML5)
  • modular framework (games + widgets)
  • low / medium level of programming required
  • powerful API
  • real-time plotting with d3.js
  • integrated NDDB Javascript database
  • server can run multiple games at the same time
  • customizable waiting rooms for online games
  • works on mobile devices and tablets
  • installation is required only for the server, clients just need their browser windows
  • integrates smoothly with other libraries and web services, such as Amazon Mturk

Quick start

nodeGame comes with a default game installed. It is called the Ultimatum game. To play it follows the steps:

  1. Download node.js (from http://nodejs.org/)
  2. From the console type: npm install nodegame
  3. Browse to the nodegame folder and start the server: node server.js
  4. Browse to the ./games/ultimatum/server/ folder and start the game logic: node logic.js
  5. Open three or more browser windows pointing to localhost:8080/ultimatum/index.html

There is more...

  • A waiting room: localhost:8080/ultimatum/room.html
  • A Monitor interface: localhost:8080/ultimatum/monitor.html
  • Real time plotting of the results: localhost:8080/ultimatum/results.html

For further information refer to the documentation in nodeGame wiki

Source codes

All source codes of all repositories of nodeGame and related projects are available at the web page: https://github.com/nodeGame

IMPORTANT: At the moment the master branch of the github repository has been refactored, and the current documentation is slightly outdated, and refers to the version available from npm.

Building from sources

Before going any further make sure you've installed git and node.js on your machine. Then open your Command Line and follow the instructions below.

# cd into the directory where you want the repo to reside
$ cd Desktop
  
# clone the repo
$ git clone git://github.com/nodeGame/nodegame.git
  
# update the dependencies
$ cd nodegame
$ npm install

Continue from point 3. of the section "Quick Start".

Code contributions

Code contributions are welcome, please keep in mind default Code Conventions.

License

Copyright (C) 2012 Stefano Balietti

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.

About

Complete nodegame repository with examples and documentation

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%