OCAWAI

Projet de Génie Logiciel du MPRI, année 2014-2015

#Installer OCAWAI

Vous trouverez tous les détails d'installation dans le fichier INSTALL.md

#Lancer OCAWAI

Il suffit de lancer la commande ocawai.

Utiliser OCAWAI

La navigation dans les menus se fait avec les flèches et la validation avec la touche entrée

Commandes

• ctrl+Q ou ctrl+C : Quitter l'application
• touches fléchées : Déplacer la caméra
• espace : Actions (déplacements, menus)
• entrée : Affiche le menu (forfeit permet de revenir au menu principal)
• A : Dézoomer
• Z : Zoomer
• M : Zoome au minimum/Rétablit le zoom
• 0 : Réinitialiser le zoom
• X : Prochaine unité (ou bâtiment) n'ayant pas joué
• W : Idem à l'envers
• S : Baisser la vitesse des animations
• D : Augmenter la vitesse des animations

Compilation

Le projet étant en Ocaml il vous faudra un compilateur Ocaml avec une version supérieur à 4.02. De plus, il vous faudra une version de la SFML >= 2.0.

Le support pour le système d'exploitation Windows n'est pas assuré.

##Dépendances du projet

Pour installer les bibliothèque externes, utiliser opam peut s'avérer être plus facile.

Il vous suffira alors d'entrer la commande

opam install ocamlfind ocsfml atdgen dolog mm pulseaudio oUnit

pour installer les dépendances du projet.

###Bibliothèques externes (Ocaml) :

• ocamlfind
• ocsfml
• atdgen
• dolog
• mm
• num
• threads
• pulseaudio
• oUnit

##Compilation

Si c'est la première fois que vous générer le projet, lancer la commande aclocal -I m4.

• autoreconf configure.ac : Générer le fichier configure
• ./configure : Générer le makefile si les dépendances sont satisfaites
• make interface : Compiler l'interface graphique
• make engine : Compiler le moteur
• make network : Compiler la partie réseaux
• make doc : Compiler la documentation
• make : Compile l'interface
• make run : Compile le jeu et le lance

Si vous faites une modification dans le Makefile.in (et surtout pas le Makefile). Vous avez juste à utiliser make Makefile pour le mettre à jour.

Backtrace

Lors qu'une exception est levée, il est possible d'afficher la trace d'éxécution si on a au préalable lancé export OCAMLRUNPARAM=b (ce qui peut être mis dans son .bashrc ou .bash_profile).

Distribuer le projet

• make dist : Créer une archive tar.gz du projet

Documentation

La documentation est générée en utilisant make doc. La documentation est accessible depuis le lien symbolique documentation.html dans le répertoire où vous avez compilé le projet.