nodegame/nodegame

Complete nodegame repository with examples and documentation

nodeGame

Fast, scalable JavaScript for large-scale, online, multiplayer, real-time games and experiments.

---

The Good parts

• Open source and open standard (HTML5)
• Modular framework (server / client / window / widgets / games)
• Low / medium level of programming required
• Powerful API
• Integrated NDDB Javascript database
• Server can run multiple games at the same time
• Powerful and customizible waiting rooms
• Monitor interface
• Works on mobile devices and tablets
• Bots (for playing) and Phantoms (for testing)
• Installation is required only for the server, clients just need their browser windows
• Integrates smoothly with other libraries (e.g. jQuery, D3.js, etc.) and web services, such as Amazon Mechanical Turk

Quick Start

nodeGame comes with a default game taken from the academic literature of game theory. It is called the Ultimatum game. To play it follows the steps:

1. Download the latest version of node.js for your platform
2. Download the latest version of git for your platform
3. Download installer, and install nodegame: node nodegame-installer
4. Enter installation directory.
5. Start the server with the command: node launcher.js
6. Open one tab pointing to localhost:8080
7. Select Ultimatum game
8. Open more tabs, or start a bot through the waiting room interface
9. Check the monitor interface at localhost:8080/ultimatum/monitor

Documentation

Complete documentation is available in the nodeGame wiki.

License

MIT

nodegame's Issues

Aliases in stages do not work if the steps to the referenced stage are added after the alias

Example:

This does not work:

  stager
        .next('instructions')
        .next('quiz')
        .repeat('game', settings.REPEAT)
        .repeat('game AS game2', settings.REPEAT)
        .repeat('game AS game3', settings.REPEAT)
        .next('questionnaire')
        .next('end')
        .gameover();

    stager.extendStage('game', {
        steps: ['bid', 'results']
    });

This works:

  stager
        .next('instructions')
        .next('quiz')
        .repeat('game', settings.REPEAT)

    
    stager.extendStage('game', {
        steps: ['bid', 'results']
    });
    
    stager.repeat('game AS game2', settings.REPEAT)
        .repeat('game AS game3', settings.REPEAT)
        .next('questionnaire')
        .next('end')
        .gameover();

When it does not work, node.game.plot.getStep fails because inside the sequence the aliasing stage has empty steps array.

Installer should check for npm installed and version

Keep track of disconnected players in PlayerList

It is a bit unclear what is the best action plan here, because this change could break many things. Maybe a separate list with disconnected players is safer.

launcher does not pass the ssl folder correctly

installer should set games path of nodegame-generator

Table should have a smart parse function

At the moment every parse is destroying and rebuilding everything.

session restoring upon reconnection is broken

v 0.5

Check if a parameter is a directory instead of file and catch the error gracefully

Waiting Room Parameters (in particular Group Size) could depend on Treatment

Get HITID by name

W.searchReplace

Seems broken, or at least the API could be improved, with wiser defaults.

Get qualification by name

launcher should control the version

Examples:

• node launcher -v 4
• node launcher set version 4

Suggestion for room names in data directory

It would be nice if the numbers on the subdirectories of the data directory were more digits (at least four, maybe even five or six), with leading zeros. For example, instead of room7 have room00007. This way they'd sort in tidier fashion.

If bonus === 0 do not attempt to send it

Record the action and show it in the summary

Keep track of opened past opened files

Whenever a result file has been opened in the past, a warning should be shown when it is re-opened again, and possibly a list of actions that has been performed with that file.

installer should make clickable link on terminals that allow them

Use ansi-escapes codes

However, do not add dependencies to installer!

Update build file

• It should use cross-platform file naming (require('os'); os.sep; path.resolve)
• It should make sure the version number is written correctly into the build

CopyFileSync is not available in Node < 8

Create Widgets to Write Text Input with Type checking

Add integration with nodegame-mturk

Server should keep up of auth codes between sessions

Auth codes, or simple ids, could be saved on request to file system, and reloaded when the server is restarted.

pull updates from nodegame website

Periodically, upon starting the server (or only by explicit request), current version should be checked against latest, and user should be prompted to update or not.

@dev installer fails in ubuntu subsystem of windows 10

Oops! The following error/s occurred:

{ Error: EACCES: permission denied, rename '/home/balistef/www/node_modules/nodegame' -> '/home/balistef/www/nodegame-v4.0.4'
at Object.renameSync (fs.js:589:3)
at someMagic (/home/balistef/www/nodegame-installer.js:387:12)
at execFile (/home/balistef/www/nodegame-installer.js:248:21)
at ChildProcess.exithandler (child_process.js:280:7)
at ChildProcess.emit (events.js:182:13)
at maybeClose (internal/child_process.js:961:16)
at Socket.stream.socket.on (internal/child_process.js:380:11)
at Socket.emit (events.js:182:13)
at Pipe._handle.close (net.js:599:12)
errno: -13,
syscall: 'rename',
code: 'EACCES',
path: '/home/balistef/www/node_modules/nodegame',
dest: '/home/balistef/www/nodegame-v4.0.4' }

Installation did not complete successfully.

installer @dev does not install git module for the top directory

As title

Warning if same person has been bonused already

Git Pre-commit hook should print which line is longer than 80 chars

As title.
By the way, I modified the limit from 81 to 82 chars, because the new line also counts as a character, and we don't care

Create Widget to Display Messages

Should ideally fit in the header, and should be an area where error, warn, and log messages are displayed

Auto add some properties to items

Creates a player.model.js or .json file where missing properties are added by default to every player object in db.

Game.getPreviousStep() is broken after reconnection

TODO: Revert to plot.jump in case of reconnection.

Create a Levels Master File

At the moment players need to be moved manually across levels. A file could contain the order of levels and the criteria to be moved into them.

Maybe all levels should be inside levels (also the default one), although it would be nice to guarantee backward compatibility

Submodules' buildfiles should not be indexed

roomCounterSeparator

As specified in channel.settings, to be implemented.

Is the tagged index in nodegame-server ChannelRegistry still needed?

Show list of previously connected (now disconnected) players

SVOGauge add SVO Type

svoGroup = 1 if svo_degree < -12.04 // competitive
svoGroup = 2 if svo_degree >= -12.04 & svo_degree < 22.45 // individualistic
svoGroup = 3 if svo_degree >= 22.45 & svo_degree < 57.15 // prosocial
svoGroup = 4 if svo_degree >= 57.15 // altruistic

Table could support adding by headings / labels

A nice to have feature

Installer seems to be broken with node 8

Installation for dev and latest fails because smoosh cannot install a sub-module.

The easy fix is to stop the installation under node 8 and show a warning.

I haven't try installing the stable version on node 8, maybe that works if does not require a smooshed file.

switch from current pre-commit hook to one using eslint

See https://medium.com/@shettyrahul8june/how-to-run-eslint-using-pre-commit-hook-25984fbce17e

update from jade to pug

launcher compile and launch phantoms

Phantoms might fail if they are alongside compilation (receive incomplete or missing nodegame-full).
Example of command:

node launcher -b widgets -p ultimatum -n 2

Documentation: create separate page for Levels

Explain also DISPATCH_TO_SAME_ROOM option

Can we make a simple auto-phantom or auto-bot?

...

add private directory to index

Add sample of input-codes db file

Add example in readme for validation.

Dictator Game Needs Cleanup

Is auth.js file still needed?

Maybe we can merge all its options in auth.settings.js

Having a frameCb?

Maybe this is more a nodegame-window issue.
To consider, it would make (auto) bots and phantoms easier to write.

installer option to add git hooks

If @dev option is selected it should by default copy the git-hooks inside the directories

node.player.id should be added also to node.id