3.5.1. Formats et nomenclature
🔤 Formats
- Formats attendus : .zip (dossier du projet Unreal compressé)
Nommage de fichiers et dossiers de design : Convention de nommage générale
3.5.2. Livrables
En général, tous les projets de création de jeu vidéo ont la liste de livrables suivante. Chaque projet va spécifier quels items sont obligatoires ou optionnels.
- Dossier source du projet :
- Un lien accessible pour un dépôt sur GitHub (si applicable), dépôt nommé
initiales_nom_prenom_groupe. - OU un fichier zip avec le dossier source complet et prêt à ouvrir, nommé
nomduprojet_nom_prenom_groupe.zip(ex.tp1_ross_bob_1021.zip).
- Un lien accessible pour un dépôt sur GitHub (si applicable), dépôt nommé
- Documentation : fichier README.md à la racine du dossier du projet.
- Exécutables : application jouable prête à lancer sous forme d’un fichier zip. Inclure l’indication de plateforme dans le nom du dossier (ex.
nomprojet_nom_prenom_groupe_windows,_mac,_linux). - Démonstrations vidéo (selon les consignes) :
- Lien accessible sur YouTube OU fichier dans la plateforme prescrite.
- Suivre les normes de la section 3.7. Vidéo.
- Tous les éléments à montrer doivent être lisibles, affichés ou audibles.
- Mentionner au début : nom de l’élève ou équipe et le sujet de la vidéo.
3.5.3. Structure du dossier source et nomenclature en Unreal Engine
Il est exigé de suivre les conventions de nomenclature et organisation de dossiers et fichiers selon les logiciels utilisés.
3.5.4. Documentation
La documentation sur un projet de jeu doit être placée dans un fichier README.md à la racine du dossier de projet (ou du dépôt GitHub). Le modèle de README pour modifier est disponible ici (lien à venir). Elle doit inclure :
- Résumé — un paragraphe court et descriptif qui introduit le projet.
- Instructions de jeu — liste courte des principaux actions et dispositifs d’entrée utilisés.
- Captures d’écran — 2 à 4 images, résolution idéale 1920 × 1080 px, format png ou jpg.
- Équipe (ou nom de l’élève si individuel). Inclure une adresse de contact par personne.
- Logiciel utilisé — nommer la version (ex. Unreal Engine 5.6.1).
- Crédits — essentiels pour les ressources externes utilisées. Citation avec le nom de la source, lien, type de licence et droits d’auteur.
- Cours et date de création — année et session.