Installation

TODO :) with go get. Maybe even explain installing/setting up go?

Node dependencies for minification:

sudo npm install -g less uglify-js

Running

First, compile the server by simply running go build.

By default, the server listens on localhost:8080, in order to specify a different port to listen to, but also to listen to an interface which is opened to the world, set the -addr to your hostname or public IP:

$ ./mwdns -addr jupiler:9000

Positions and coordinates

Coordinate-system is the javascript one, (0,0) being top left, x increasing towards the right, y increasing towards the bottom.

Client-side (js), all positions are stored in pixels. In the messages aswell as on the server (go), all positions are relative in % of game board size, i.e. between 0.0 and 1.0 if on the board.

Message types

The messages sent through the websockets during a game.

Server to client

initBoard

maxPlayers == 0 means no limit. the colors array is only non-empty when the server provides the color palette information.

{
	"msg": "initBoard"
	"boardWidth": 500
	"boardHeight": 600
	"cardCount": 13
	"maxPlayers": 2
	"colors": [colorString, ...]
}

cardMove

x,y are the center of the card as a relative (%) position on the board. phi is the angle in degrees.

{
	"msg": "cardMove",
	"id": 13,
	"x": 0.13,
	"y": 0.52,
	"phi": 30,
}

cardOpen

type is the "picture" on the card ; you could also call it "class" if you prefer.

If the card happens to be scored, the scoring player id is saved in scoredBy.

{
	"msg": "cardOpen",
	"id": 13,
	"type": 4,
	"scoredBy": -1
}

cardsClose

When one or more cards need to be flipped closed together. The client probably wants to do that with a little delay, as it will be sent immediately after the second card is opened.

{
	"msg": "cardsClose",
	"ids": [13, 10]
}

chatmsg

{
	"msg": "chat",
	"from": "luck.duck",
	"content": "gg n00bs"
}

points

{
	"msg": "points",
	"pid": 13,
	"points": 9001
}

turns

{
	"msg": "turns",
	"pid": 13,
	"turns": 2,
	"flips": 4
}

player

This message is sent both whenever a new player joins and when a player changes his name or color.

{
	"msg": "player",
	"pid": 13,
	"itsyou": false,
	"name": "Bob",
	"points": 2,
	"flips": 18,
	"turns": 18,
	"color": "#F00"
}

leaver

{
	"msg": "leaver",
	"pid": "13"
}

canplay

{
	"msg": "canplay",
	"pid": 13,
	"canPlay": false
}

endgamemsg

{
	"msg": "end"
}

errors

err_gameid

{
	"msg": "err_gameid",
	"gid": "XZejbF"
}

err_gamefull

{
	"msg": "err_gamefull",
	"gid": "FooBar",
	"max": 10
}

Client to server

wantFlip

A client can send this to the server whenever it wants to flip OPEN a card. There will be no answer. The client should wait to get a "flipped" message, or nothing ever.

{
	"wantFlip": "13"
}

chatmsg

{
	"chat": "gl, hf"
}

wantChangeName

{
	"wantChangeName": "Bob"
}

wantChangeColor

{
	"wantChangeColor": "#F00"
}

moveCard

{
	"moveCard": {
		"id": 13,
		"x": 0.25,
		"y": 0.043,
		"phi": 120
	}
}