This is the README file for Scopa.

Copyright (C) 2016 Marco Scarpetta <marcoscarpetta02@gmail.com>

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.

GENERAL INFORMATIONS
====================

This software aims to provide an implementation of the famous Italian
card game "Scopa" (https://en.wikipedia.org/wiki/Scopa). It is written
in Javascript and can work in any modern browser.
It provides 5 variations of the original game and 3 types of cards.

USAGE
=====

Open the file index.html with a web browser. Since this software uses some new
HTML features you must run it inside one of the following browsers:
 * Firefox 48 or any later version (Element.animate was introduced in version 48)
 * Chrome/Chromium 49 or any later version (css variables were introduced in version 49)

Alternatively you can use the Qt application, to be built as described in the
next section.

BUILDING (Qt application)
=========================

The Qt application is very simple. It is just a browser window, based on
Qt WebEngine, that opens the index.html file.

It requires at least Qt 5.7.0, since the Qt WebEngine shipped with this version
is based on Chromium 49.

The following instructions refer to a GNU/Linux system.

To build the application run:

  make

You can use the following command to run the application:

  ./build/bin/scopa

To install the application inside the DIR directory run:

  make DESTDIR=DIR install

Then you can run it with the following command:

  ./DIR/usr/bin/scopa

Or simply run "scopa" if DIR/usr/bin is in your PATH variable.

BUILDING AND RUNNING THE SERVER
===============================

The online server requires node.js and the ws module (https://github.com/websockets/ws).

To install the server inside the DIR directory run:

  make DESTDIR=DIR server

Then you can run it with the following command:

  node DIR/server.js

LICENSING
=========

 * The jpg files in the "data/cards/Napoletane" directory are public domain
   images available here: https://commons.wikimedia.org/wiki/Category:Naples_deck

 * The jpg files in the "data/cards/Bergamasche" directory are cropped from
   the public domain image available here: https://commons.wikimedia.org/wiki/File:Carte_bergamasche.jpg
   
 * The jpg files in the "data/cards/Piacentine" directory are cropped from
   the public domain image available here:
   https://commons.wikimedia.org/wiki/File:Carte_piacentine_al_completo.jpg
   
 * The jpg files in the "data/cards/Poker" and "data/cards/Poker_figures" directory are public domain
   images available here: https://commons.wikimedia.org/wiki/Category:Playing_cards_set_by_Byron_Knoll
   
 * All files inside the "server" directory are released under
   the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
    
 * All other files are part of
   Scopa, Copyright (C) 2016 Marco Scarpetta <marcoscarpetta02@gmail.com>

   Scopa is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   Scopa is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with Scopa.  If not, see <http://www.gnu.org/licenses/>.