Age of Olympia v4

Dans cette première page se trouve la documentation pour lancer le projet. Pour l'architecture du code, il faut suivre ce lien : Architecture du code

Démarrage de l'environnement de développement

L'environnement de développement est un devcontainer. Le devcontainer est une fonctionnalité proposée par vscode, il est donc recommandé d'utiliser vscode pour travailler sur ce projet.

Pré-requis

Pour que l'environnement fonctionne correctement, il faut installer les pré-requis suivants :

• Docker
• VsCode avec l'extension Dev Containers

Démarrage

Clonez le dépot aoo-engine. Le dépot aoo-game_data n'est pas necessaire au fonctionnement. (Sur Windows, utilisez WSL pour cloner le dépot)

À la racine, dupliquez le fichier .env.dist, puis renommez le .env. Dans /config/, supprimez le dossier db_constant.php puis cpiez le fichier db_constants.php.exemple et renommez le db_constants.php. Ouvrez le puis ajoutez :

'driver' => 'mysqli',
'charset'=> 'utf8'

Une fois ce dépôt cloné et les modifications précédentes effectuées, le fait de l'ouvrir dans vscode devrait ouvrir le pop-up suivant :

En cliquant sur ce bouton, VsCode va redémarrer et builder l'image Docker qui contiendra l'environnement de développement.

Cette image peut-être un peu longue à construire la première fois, n'hésitez pas à afficher les logs, ça occupe !

A la fin de la construction, le devcontainer va lancer les commandes de base pour télécharger les ressources néssaires, en particulier composer install.

Une fois que c'est fait, on se retrouve dans la fenêtre suivante :

Vous pouvez alors vérifier que trois conteneurs sont démarrés, par exemple ici avec Docker Desktop :

C'est presque prêt !

dupliquez le fichier "config/db_constants.php.exemple" vers "config/db_constants.php"

et mettez le contenu suivant :

define('DB_CONSTANTS', array(
    'host'=>"mariadb-aoo4:3306",
    'user'=>"root",
    'psw'=>"passwordRoot",
    'db'=>"aoo4",
    'password'=>"passwordRoot",
    'dbname'=>"aoo4",
    'driver' => 'pdo_mysql',
));

A l'aide de la commande :

  id

Récupérer votre uid et votre gid puis dupliquez le fichier ".env.dist" vers ".env" et mettez le contenu suivant :

UID=VOTRE_UID
GID=VOTRE_GID

sauvegardez et vous être prêt !

Premiers pas sur le jeu

Pour pouvoir lancer le jeu, il faut copier les repertoires que l'on trouve dans datas_standalone et img_standalone respectivement vers les dossiers datas et img.

Le fichier db/init_noupdates.sql est lancé par le docker-compose.yml automatiquement pour peupler la base.

Ces actions vont entre autre créer trois personnages :

• Cradek, matricule 1, Nain, administrateur
• Dorna, matricule 2, Nain, joueur
• Thyrias, matricule 3, Elfe, joueur

Pour s'y connecter, le mot de passe est test.

Pour ouvrir la console d'administration il faut utiliser ² une fois connecté ou cliquer sur le bouton pour ouvrir la console dans le menu des paramètres, en haut à droite de l'écran de jeu.

Lancement du serveur

Il ne reste plus qu'à démarrer le serveur :

apache2-foreground

Voici le résultat attendu :

Attention, il exite un bug dans apache qui fait que le serveur d'arrête avec le signal SIGWINCH lorsque l'on redimensionne la fenêtre du terminal. Il suffit alors de le relancer.

Debug

Une fois le serveur lancé, on n'a plus qu'à lancer le debuggueur et on a alors accès au pas à pas et à l'observation des valeurs des variables.

Pour lancer le debuggeur, il suffit de se rendre dans la section "Run and Debug" à gauche, puis de choisir la cible "Listen for Xdebug".

Une fois que c'est fait, on peut mettre un point d'arrêt et observer le résultat d'un appel.

Modification de l'environnement de travail

Il est évidemment possible de modifier l'environnement de travail en modifiant les fichiers situés dans le dossier .devcontainer.

Une fois que c'est fait, il faut alors reconstruire le devcontainer : il faut appuyer sur F1 puis taper "Dev Container" dans le moteur de recherche, les différentes commandes, dont celles de reconstruction, apparaîtront.

Automatisation & CI

Afin de centraliser les commandes et de faciliter le développement, nous avons mis en place un Makefile qui est utilisé à la fois en local et dans la CI.

Makefile

• Permet de lancer les commandes (tests, build, etc.) très facilement.
• Utilisé aussi dans la CI pour éviter la duplication des scripts.
• Exemples de commandes :

make test

---

CI

Il s'agit d'un chaîne CI complète avec les éléments suivants :

• Registry Docker avec système de cache pour optimiser les builds.
• Templates dans .gitlab-ci.yml afin d’éviter la duplication des commandes.
• Arrêt automatique de la CI en cas d’échec d’un test.
• Schéma du fonctionnement de la registry ajouté dans la documentation.

---

Tests

Type de test	Détail
Unitaire	Tests pertinents sur les fonctions critiques, notamment calculateXp.
Qualité	PHPStan appliqué uniquement sur tests/.
Sécurité	Vérification des failles de type injection SQL.

---

Documentation

• CI: https://gitlab.com/age-of-olympia/aoo-engine/-/tree/dev/gitlab-ci

---

Ressources

• Project: https://gitlab.com/age-of-olympia/aoo-engine/-/tree/dev
• CI: https://gitlab.com/age-of-olympia/aoo-engine/-/tree/dev/gitlab-ci
• Issue board: https://gitlab.com/age-of-olympia/aoo-engine/-/boards
• Container registry: https://gitlab.com/age-of-olympia/aoo-engine/container_registry
• Artifacts: https://gitlab.com/age-of-olympia/aoo-engine/-/artifacts