add README and finish MVP product

This commit is contained in:
2026-03-28 13:30:40 +01:00
parent 3d9ba13bff
commit 684c0d2f07
28 changed files with 130 additions and 33 deletions

View File

@@ -1,18 +1,78 @@
## Getting Started
🚀 ZENITH FLUX — Montez plus haut
Welcome to the VS Code Java world. Here is a guideline to help you get started to write Java code in Visual Studio Code.
ZENITH FLUX est un jeu dadresse et de précision développé en Java dans le cadre du module Projet Dev - CPI2 2026.
Le joueur doit maintenir un anneau en lévitation le long dune trajectoire en mouvement, en défiant la gravité pour atteindre le score le plus élevé.
## Folder Structure
🎯 Concept du jeu
The workspace contains two folders by default, where:
Le gameplay repose sur un principe simple mais exigeant :
- `src`: the folder to maintain sources
- `lib`: the folder to maintain dependencies
⚖️ Gravité constante : lanneau est continuellement attiré vers le bas
🚀 Impulsion verticale : le joueur doit compenser cette chute avec précision
🎯 Suivi de trajectoire : rester aligné avec une ligne brisée en mouvement
📈 Progression : difficulté croissante à travers plusieurs niveaux (stages)
Meanwhile, the compiled output files will be generated in the `bin` folder by default.
👉 Le défi : tenir le plus longtemps possible sans sortir de la trajectoire
> If you want to customize the folder structure, open `.vscode/settings.json` and update the related settings there.
🎮 Fonctionnalités
✔️ Gameplay dynamique basé sur la physique
✔️ Système de niveaux configurables
✔️ Sauvegarde des performances (score, durée, progression)
✔️ Interface simple et immersive
✔️ Expérience complète : introduction, montée en difficulté, fin de partie
👥 Équipe de développement
## Dependency Management
Projet réalisé par :
The `JAVA PROJECTS` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-dependency#manage-dependencies).
Constant Eloundou
Lucas Lample
Ismaël Boubacar
Théo Mouniapin
🛠️ Technologies utilisées
Langage : Java (Programmation Orientée Objet)
Architecture : UML (Diagrammes de classes, séquences, activités)
Base de données : SQLite
💾 Persistance des données
📊 Historique des parties :
Date
Durée
Score
Niveau atteint
🧩 Configuration des niveaux :
Paramétrage dynamique des stages
Modification possible sans recompiler le jeu
📦 Contenu du dépôt
Ce dépôt contient :
📁 Code source Java (documenté avec JavaDoc)
📊 Diagrammes UML complets
📝 Rapport de projet (organisation, tâches, contributions)
▶️ Exécutable (.jar) prêt à être lancé
📖 Guide utilisateur (installation et commandes)
🚀 Installation et lancement
🔧 Prérequis
Java JDK/JRE 17 ou supérieur
📥 Cloner le projet
git clone https://github.com/votre-repo/zenith-flux.git
cd zenith-flux
▶️ Lancer le jeu
java -jar ZenithFlux.jar
📅 Planning de développement
Semaine Objectif
1 - 2 Prise en main du projet + prototype
3 - 5 Développement intensif + fonctionnalités avancées
6 Finalisation, optimisation et soutenance
🧠 Points forts du projet
Architecture propre et modulaire
Séparation claire entre logique, données et affichage
Utilisation concrète dune base de données
Projet complet : de la conception à la livraison
⚖️ Licence
Projet réalisé dans un cadre pédagogique (CPI2 2026).
Usage académique uniquement.
❤️ Remerciements
Merci à tous les encadrants et contributeurs du projet.