Skip to content

ZelmoTheDragon/cube

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cube

Présentation

Un simple prototype de moteur de jeu 2D basé sur JavaFX & Swing/AWT. Ce projet est sous licence CeCILL (CEA CNRS INRIA Logiciel Libre), une licence de logiciel libre compatible avec la GNU GPL.

En savoir plus sur la licence CeCILL

Objectifs

  • Mettre en oeuvre une architecture hexagonale
  • Comparer deux implémentations JavaFX & Swing/AWT

Module

Le projet est découpé en modules:

  • cube
    • Projet de référence Maven pour la configuration de tous les autres modules.
  • cube-core
    • Le cœur du projet, comporte toute la logique de traitement en pur Java sans dépendance externe.
    • Comporte par défaut des fonctions de rendu graphique basé sur la manipulation de tableaux de pixels.
  • cube-fx
    • L'implémentation basé sur JavaFX, comporte le moteur du jeu.
  • cube-awt
    • L'implémentation basé sur Java Swing/AWT, comporte le moteur du jeu.

Architecture

L'architecture logicielle mis en place est ECS (Entity Component System) en respectant au mieux les règles d'élégance du code (clean code) et S.O.L.I.D..

  • Entity
    • Représente un élément métier du jeu
    • Exemple: un personnage, un monstre, un projectile, etc...
  • Component
    • Représente une propriété d'une d'entité
    • Exemple: une position, un vecteur, une barre de vie, etc...
  • System
    • Représente la logique de traitement, un système manipule des entités
    • Exemple: un système de collision, un système de déplacement, un système de rendu graphique.

Le code n'est pas conçu pour être performant à la base, mais structuré! Ainsi, il devient plus facile de le faire évoluer.

Environnement

Ce projet est réalisé en Java 14 (OpenJDK). et JavaFX 14 (OpenJFX). Il utilise l'outil Maven en version 3.6.3.

Exécution

Récupération du projet:

    git clone https://github.com/ZelmoTheDragon/cube.git
    mvn install

Moteur JavaFX

Se placer dans le module:

    cd cube-fx

Exécuter le module:

    mvn javafx:run

Générer une image autonome:

    mvn javafx:jlink
    target/cube-fx/bin/launcher

Moteur Java Swing/AWT

Se placer dans le module:

    cd cube-awt

Exécuter le module:

    mvn exec:java

About

JavaFX / AWT pixel rendering engine for game

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages