/*! \mainpage The adventures of the masked duck

English version: (by ntome on qt-fr channel on freenode network)
  Game presentation: The adventures of the Masked Duck
    Story
    Objective
    Commands
  Game editor
  Compilation
French version:
Présentation du jeu : Les aventures du Canard Masqué
Histoire
Objectif
Commandes
L'éditeur du jeu
Compilation

It all began on an ordinary sunny day.
When a duckling cried for help, our hero quickly came to see why she was quacking.
She said her mother's egg had been stolen!
While walking around, our hero noticed it wasn't the only egg missing, but the nearby wolf footprints were more alarming.
So our hero put his Masked Duck suit on to find the stolen eggs, but above all the egg of the mother duck.

The game objective is to retrieve all the eggs spread around the worlds and avoid the traps put by the wolves.

When selecting a world or a step:

  Arrow keys: Select world or step.
  Enter: Choose world or step.
  Escape: Show/Hide menu.

In a level:

  Left/Right: Move the Masked Duck.
  Up: Open door.
  Escape: Show/Hide menu.

In the menu:

  Enter: Choose menu option.
  Escape: Hide menu.

The game editor allows new worlds to be easily created by generating the necessary code for the world.
The game dynamically loads libraries that each represent one world, so the generated code must be compiled in order to play this map.

The Qt framework and a C++ compiler toolchain must be installed to compile the project.
Run the following lines to compile the project:

  qmake
  make

( Under MacOSX, it will be necessary to link in addition to that various libraries between them, see otool / macdeployqt, an automation is in development)

Tout commence un beau jour ensoleillé comme les autres.
Quand une jeune canette cria à l'aide, notre héros accourra vers elle pour comprendre la cause de ces cris.
Elle lui dit que l’œuf de sa mère avait été volé !
En inspectant les alentours, notre héros remarqua que ce n'était pas le seul œuf qui avait été volé mais le pire était les traces de loups non loin.
C'est alors que notre héros pris son costume du Canard Masqué pour retrouver les œufs volés, mais surtout celui de la mère à la jeune canette.

Le but du jeu est de récupérer tous les œufs éparpillés dans les mondes tout en défiant les pièges des loups.

Dans la sélection d'un monde ou dans un monde :

  Touche directionnelles : Sélectionner le monde ou une étape.
  Entrée : Valider le monde ou une étape.
  Échap : Afficher / Masquer le menu.

Dans un niveau :

  Gauche / Droite : Déplacer le Canard Masqué.
  Haut : Ouvrir une porte.
  Espace : Sauter.
  Échap : Afficher / Masquer le menu.

Dans le menu :

  Entrée : Valider l'option du menu.
  Échap : Masquer le menu.

Cette éditeur permet de créer facilement les mondes pour le jeu, il génère le code nécessaire pour celui-ci.
Le jeu charge dynamiquement des bibliothèques qui représente chacune un monde, il faut donc compiler le code généré pour le faire fonctionner avec ce dernier.

Pour compiler le projet, il faut avoir installer le Framework Qt ainsi que les outils de compilation pour C++.
Exécuter ces lignes pour compiler le projet:

  qmake
  make

(Sous MacOSX, il faudra en plus de cela lier les différents bibliothèques entre elles, voir otool / macdeployqt, une automatisation est en cours de codage) */