TheTrueHat

Available languages: in English, in Russian.

TheTrueHat is a web-application for the game Alias. You can play the Alias with your friends or organise an Alias tournament. This project supports a web-interface for the game, and a server that will took responsibility for all technical details.

Play now!

The game is available now here.

Features

• Cross-platform. You can set the server up on Windows, Linux and Mac OS X, and web-application supports Google Chrome (PC and Android), Mozilla Firefox (PC and Android) and latest Opera (PC and Android).
• Easy to start. It's ready to start right now. You don't need to delve into anything and code anything to start play.
• Good performance: this project is written on Node.js - one of the fastest frameworks.

Quick start

Warning. Don't use this instruction on production. See our documentation before.

Installation

1. Install Node.js
2. Install Caddy v.1
3. Download the repository.
4. Add post-checkout git hook (executable file .git/hooks/post-checkout) with the following content (see also this readme):

   #!/bin/bash
   exec version/post-checkout.hook
   

   This script runs upon checkout, so checkout is required for generation of versioning files.
5. Run in a console in the project directory:

   npm install --only=prod --no-fund
   

Fast tuning

1. Modify Caddyfile in project directory in such way:
   1. Replace <project_dir> with the project path.
   2. Replace <log_dir> with path for Caddy log file (for example, the project path).
   3. Replace <error_dir> with path for Caddy error file (for example, the project path).
   4. Replace all <port> with some vacant port.
   5. Replace all <socket_port> with another vacant port.
2. Modify config.json in project directory in such way:
   1. Update value by key "port" with your <socket_port> parameter.

Launching and using

1. Run in the first console with working directory in project directory:

   caddy -pidfile=caddy.pid
   

2. Run in the second console with working directory in project directory:

   node server.js
   

3. Go by the link http://localhost:<port> with <port> replaced by your <port> parameter.
4. Have fun!

Stopping

Just stop processes in both consoles you used to launch project.

Documentation

You can see the documentation here.

Gratitude

We want to express gratitude for their cooperation to SIS.Hat project.

License

This project is available by MIT license.

Used products

• Caddy v.1
• Node.js
• Express
• Socket.IO
• body-parser
• yargs
• po2json
• gettext