L'obiettivo principale del progetto è implementare il gioco da tavolo MyShelfie utilizzando l'architettura Model View Controller (MVC), secondo il paradigma di programmazione orientato agli oggetti. Il risultato finale rispetta integralmente le regole del gioco e offre la possibilità di interagire con esso attraverso un'interfaccia a riga di comando (CLI) o tramite un'accattivante grafica (GUI). Per quanto riguarda la comunicazione via rete, sono state utilizzate sia le socket che RMI.
Nella seguente documentazione sono inclusi i documenti sviluppati per la progettazione del gioco. Prima verranno presentati gli elenchi dei diagrammi delle classi in UML, seguiti dalla documentazione del codice (JavaDoc).
Di seguito sono riportati diagrammi delle classi dell’architettura di rete dei client e del server
- UML alto livello client server
- UML dettagliato client
- UML dettagliato server
- Descrizione protocollo comunicazione client server
Il presente documento fornisce una descrizione dettagliata della maggior parte delle classi e dei metodi utilizzati nel progetto, seguendo le convenzioni di documentazione di Java. È possibile consultare questa documentazione cliccando qui
| Libreria/Plugin | Descrizione |
|---|---|
| maven | Strumento di gestione per software basati su Java e build automation |
| junit | Framework dedicato a Java per unit testing |
| gson | Libreria per il supporto al parsing di file in formato json |
| JavaFx | Libreria grafica di Java |
| jacoco | Strumento di supporto al testing per evidenziare le linee di codice coperte dagli unit test |
Per la consegna del progetto sono stati utilizzati i seguenti Jar, i quali consentono di avviare il gioco secondo le funzionalità descritte nell'introduzione. Le funzionalità sviluppate in accordo con la specifica del progetto saranno elencate nella prossima sezione, mentre i dettagli relativi all'esecuzione dei Jar saranno forniti nella sezione denominata "Esecuzione dei Jar". La cartella che ospita l'eseguibile del client e del server si trova all'indirizzo seguente: Jars.
- Regole complete
- CLI
- GUI
- Socket
- RMI
- Partite multiple
- Resilienza alle disconnessioni
Il client può essere eseguito in due modalità: CLI e GUI; il giocatore può scegliere la modalità di gioco tramite un comando apposito all'inizio dell'esecuzione del Jar.
Per eseguire in client in modalità testuale, è necessario eseguire il seguente comando da terminale, specificando che si vuole eseguire l'interfaccia a riga di comando:
java -jar client.jar cliPer poter eseguire MyShelfie con interfaccia grafica è sufficiente digitare il seguente comando:
java -jar client.jar
L'esecuzione del Server prevede la lettura di un file di configurazione di tipo Json, contenente costanti e impostazioni di gioco; i valori eventualmente modificabili sono i seguenti:
"socketPort": 6666,
"RMIPort": 7777,
"maxPlayers": 4,
"minPlayers": 2,
"disconnectionTimer": 120000,
"moveTimer": 300000
socketPort: porta del server che usa le socket.RMIPort: porta del server che usa il servizio RMI.maxPlayers: numero massimo di giocatori che possono partecipare ad una partita.minPlayers: numero minimo di giocatori che possono partecipare ad una partita.disconnectionTimer: tempo in millisecondi che il server aspetta prima di considerare un giocatore definitivamente disconnesso dalla partita in corso.
Inoltre, il file contiene anche tutte le personal goal card presenti nel gioco e le possibili configurazioni della plancia di gioco in base al numero di giocatori.
L'esecuzione del server avviene attraverso il seguente comando, in cui si specifica il percorso del file di configurazione:
java -jar server.jar [configFilePath] Se non specificato nessun percorso, il valore di default di confiFilePath è GameConstant.json, il quale deve essere presente nella stessa cartella dell'eseguibile del server.