METROID

Jeu inspiré de l'univers de Metroid
Voir les Releases »

Lire le wiki · Issues · Voir le Projet

Table des Matières

1. À Propos du Projet
   • Créé avec
2. Commencer
   • Prérequis
   • Installation
3. Utilisation
• Exécution
• Génération
• Documentation
• Archive JAR
• Exécutable (optionnel)
4. Arborescence
5. Crédits
6. Contact

---

À Propos du Projet

Jeu réalisé en 2016/2017 avec Quentin Kaiffer et Marin Navarro pour le projet final de Java en 1ère année INSA Lyon. Ajout en 2021 sur GitHub avec un README et une transformation en projet Gradle avec gestion automatique des dépendances.

Compatible Windows et Linux. Les binaires macOS ne sont pas distribués par sdljava ainsi le projet n'installera pas les dépendances pour cet OS. Pour construire et exécuter METROID sur une machine de ce type, il faudra reconstruire les librairies depuis les sources de sdljava et télécharger les dépendances SDL pour macOS. Les instructions sont trouvables sur le site de sdljava.

Créé avec

• Java OpenJDK
• sdljava

Commencer

Prérequis

• Installer la version 17 32 bits de l'OpenJDK d'Azul (Zulu) disponible à cette adresse : https://www.azul.com/downloads/?version=java-17-lts&architecture=x86-32-bit&package=jdk

⚠️ Utilisation sous Linux : Afin d'extraire automatiquement les dépendances il faut installer rpm2cpio et cpio :

sudo apt-get install -y rpm2cpio
sudo apt-get install -y cpio

⚠️ Pour pouvoir créer un exécutable localement (optionnel) : D'autres programmes devront être installés manuellement selon l'OS cible (voir Exécutable (optionnel))

Installation

1. Cloner le dépôt sur votre machine

   git clone https://github.com/rmonier/metroid.git

2. METROID est maintenant prêt à être utilisé.

Utilisation

Exécution

Utiliser le script suivant à la racine du projet pour lancer METROID :

gradlew run

Génération

Pour générer la Javadoc et l'archive JAR, lancer le script suivant :

gradlew build

Documentation

Lors du build METROID utilise un script Gradle pour générer la Javadoc qui peut se retrouver à l'emplacement suivant : metroid/build/docs. Le script peut être lancé séparemment du build :

gradlew javadoc

Archive JAR

Est aussi utilisé un script Gradle lors du build pour générer l'archive JAR qui peut se retrouver à l'emplacement suivant : metroid/build/libs. Le script peut être lancé séparemment du build :

gradlew jar

Cette archive est indépendante et peut être distribuée sur tout système qui utilise un Java OpenJDK 17 Zulu 32 bits sur l'OS correspondant en utilisant la commande suivante :

java -jar metroid-1.0.1-windows.jar
java -jar metroid-1.0.1-linux.jar

Exécutable (optionnel)

Enfin un dernier script Gradle peut être utilisé après le build pour créer un exécutable compatible avec l'OS utilisé (à l'aide de l'outil jpackage) que l'on retrouvera à cet emplacement : metroid/build/dist. Le script à lancer est le suivant :

gradlew jpackage

⚠️ Pour mener à bien cette étape il faut posséder les programmes suivants selon l'OS utilisé :

• Linux: deb, rpm:
  • For Red Hat Linux, the rpm-build package is required.
  • For Ubuntu Linux, the fakeroot package is required.
• macOS: pkg, app in a dmg
  • Xcode command line tools are required when the --mac-sign option is used to request that the package be signed, and when the --icon option is used to customize the DMG image.
• Windows: exe, msi
  • WiX 3.0 or later is required.

---

Arborescence

TODO

Crédits

Romain Monier [ GitHub ] – Co-développeur
Quentin Kaiffer – Co-développeur
Marin Navarro – Co-développeur

Contact

Lien du Projet : https://github.com/rmonier/metroid