Ce document donne des informations sur les différentes fonctionnalités qui sont disponibles sur l'application Awale.
Lors du démarrage de l'application client, il est possible de s'inscrire ou de se connecter. Il faut savoir que le mot de passe et le nom d'utilisateur sont case sensitive. Ainsi, il est important d'utiliser exactement le même. Enfin, le mot de passe est stocké en clair dans un fichier du serveur.
Une fois inscrit / connecté, l'utilisateur est sur la page d'accueil de l'application. Il peut taper des commandes qui lui permettent d'exécuter des actions.
Il peut exécuter la commande aide pour voir l'ensemble des commandes disponibles.
Un joueur peut en défier un autre à l'aide de la commande DEFI <pseudo>. Cette commande est transmise au serveur, qui vérifie que le pseudo renseigné est
- connecté
- libre (pas en partie)
Si les conditions sont remplies, le destinataire reçoit une notification sur son application lui indiquant qu'un joueur souhaite le défier.
Il peut accepter ou refuser ce défi en utilisant respectivement les commande ACCEPT <pseudo> et REFUSE <pseudo>.
Si le joueur accepte la demande, la partie démarre. Les joueurs pourront jouer chacun leur tour à l'aide des commandes PLAY <trou> ou MOVE <trou> ou tout simplement <trou>.
Enfin, le joueur peut décider d'abandonner la partie à l'aide de la commande SURR. Cela terminera la partie pour les 2 joueurs.
Les joueurs peuvent discuter durant une partie, à l'aide de la commande MSG <message>. Cette commande transmet le message à l'autre joueur connecté à la partie.
A l'inverse, il est également possible d'envoyer un message à tous les utilisateurs de l'application, à l'aide de la commande BRC <message> qui transmet le message à tous les utilisateurs connectés. Cette fonctionnalité pourrait être utilisée par un administrateur lors d'un tournoi par exemple.
2 joueurs peuvent décider d'arrêter la partie pour le moment, pour la reprendre plus tard. La commande SAVE permet de sauvegarder une partie et la commande SAVE_QUIT permet de la sauvegarder et de l'arrêter.
Ces 2 commandes génèrent un fichier de sauvegarde qui permettra au joueur qui a fait la sauvegarde de relancer la partie par la suite.
Dans le menu principal, le joueur ayant créé la sauvegarde peut la relancer à l'aide de la commande RESTORE <id_partie>. Pour connaître l'identifiant de sa partie, il peut lancer la commande RESTORE, qui liste l'ensemble des parties sauvegardées sur le serveur.
La commande RESTORE <id_partie> n'est rien d'autre qu'un défi qui reprendra la partie comme elle l'était lors de la dernière sauvegarde. Ainsi, le 2ème joueur doit être connecté sur le serveur pour reprendre une partie et il a la possibilité d'accepter ou de refuser la demande à l'aide des commandes ACCEPT_RESTORE <pseudo> <id_partie> et REFUSE_RESTORE <pseudo> <id> respectivement.
Le résultat de chaque partie jouée par un joueur est stocké dans un fichier à des fins de statistique. Cela permet d'utiliser la commande STATS, afin d'afficher ses statistiques personnelles ou bien la commande RANKING pour voir un classement entre tous les joueurs du serveur.