neenuavarghese / guesswhat

guesswhat

Application can be accessed at: GuessWhat ###Prerequisites

• nodeJS
• Redis (NoSQL Database)

###Installation

1. git clone https://github.com/NeenuAVarghese/guesswhat.git
2. cd guesswhat
3. npm install

Note: these node modules will be installed via package.json by npm

• express
• multimap
• nconf
• random-js
• redis
• request
• socket.io
• xss-filters

###Playing

1. cd guesswhat
2. npm start OR foreman start OR nf start
3. Open web browser to http://localhost:3000
4. Repeat Step 3, for each client

Note: a Procfile is included for foreman or nf

Note: if redis-server and/or node are not in your PATH, then manually run

• /path/to/redis-server
• /path/to/node server/server.js

###Testing

1. Install csslint (CSS validator)
2. Install jshint (Javascript validator)
3. Install tidy (HTML validator)
4. npm test

Note: validate.sh is included with this project for testing

###Debugging Problem: Express will not start if port is already in use.

Option 1: Add a config.json file

{
    "httpPort": 8080
    "redisPort": 7777
}

Option 2: Temporarily change the port number

1. redis-server
2. node server/server.js --httpPort <number>

Problem: Redis will not start if port is already in use.

Option 1: Kill the process(es)

1. lsof -i :6379
2. kill $(lsof -t -i :6379)

Option 2: Temporarily change the port number

1. redis-server --port <number>
2. node server/server.js --redisPort <number>

Problem: Redis DB has junk data

Option 1: Set an environmental variable

export purgeDB=true

Option 2: Use CLI interface

1. redis-server
2. redis-cli flushdb

Problem: API for socket.io has changed

Option 1: Print all properties of object "guesswhat"

console.log("====> DEBUG", Object.getOwnPropertyNames(guesswhat));

Option 2: Enable verbose debugging in nodejs

DEBUG=socket.io-parser node server/server.js

Client-side libraries

• Bootstrap - grid layout
• Font Awesome - icon font
• jQuery - simplify life Javascript
• Knockout - observe user typing with MVVM
• LiveStamp - auto-update elapsed times in chat
• Moment - convert UNIX timestamps to human-readable
• Montserrat - web font
• xss-filters - sanitize user input

###Licensing Copyright © 2016

GuessWhat is dual licensed under the MIT (aka X11) and GPLv2 licenses.

guesswhat's Issues

Application should notify other users in the room that the game has started

Gameover does not display the word

Usernames not stored in DB

To-Do List

Components

• New name
• Bootstrap layout
• HTML5 canvas
• socket.IO chat
• countdown timer
• chat log parsing
• External dictionary API (onelook.com: npm)

Game logic

• Pull word/phrase and definition with API
• 1 player draws
• Other players guess word/phrase
• Sanitize input
• Search chat for correct word/phrase
• Timer ends each rounds
• Assign teams (4+ players)

Optional features

• Hangman score system
• Save/export drawings
• 1-player ghost mode (playback drawing)
• Private rooms
• So You Think You Can Draw reverse game mode (1 player guesses; other players draw)

Fuzzy matching not working

Need to improve regex rules

Closing hint modal prevents starting a new game

Steps to reproduce:

1. Login
2. Click let's start the fun
3. Close the modal before clicking start
4. Unable to start a new game (until another player has started and ended a game in that room)

When closing the modal, it should .show() the button again

Clear Canvas is not transmitted on socket

Canvas stops syncing

This happens sometimes but not always. Race condition?

Sanitize user comments

Problem: in the chat type:
<script>alert("XSS")</script>;

Solution: remove tags from user input

Player can guess their own word

Need to implement game logic. Disable chat for player that is drawing

New word doesn't refresh

Next word doesn't load, probably async issue

Same username in different groups is also not handled.

As reported by @NeenuAVarghese in issue #14

Parse chat detects as correct match when there is not word in chat

Canvas does not sync old drawing

Users only see what has been drawn since they have logged in

Chat shows time as 14 minutes ago

1. Start chat in the application
2. When messages are sent, The time stamp shows 14 minutes ago
3. It should show few seconds ago

Cannot login again

Clicking "logout" or closing the tab, the same username cannot be used again until server restarted. This is because it is still in the map.

Delayed active user list

user1 logs in, name shows up in active users
user2 logs in, only user1 name shows up
user3 logins, only user1 and user2 names show up

Can't skip word

Scoring doesn't show until game is started

Same user name in a room is not handled

Pencil does not cover entire canvas area

Content in canvas should be removed once a win is recorded

Timer does not stop when user logs out

socket.io connecting too many times

Upstream bug in socket.io, fires connect event multiple times if server has been down.

Line color history is not stored

Auto-scroll wonky

It was working before but now it's scrolling "up" instead of "down"

Need to disable 'lets start the fun' button during an ongoing game

Same username != socket.id

Same player username in room will have same score. Score should be using userid, similar to chat

Logout click removes the current user from db, but does not properly update the active users list

Multiple words can be in play at once

Canvas does not work on mobile/touch

Include JQuery-mobile library