Final Project of Software Engineering
Getting Started
This project was developed as a computer version of a game for the final examination of the Software Engineering course at Politecnico di Milano in the year 2020. The purpose of the project is the implementation of the board game Santorini with the use of the design pattern Model View Controller for the realization of a design which follows the paradigm of object-oriented programming. The final result covers entirely the rules of the game and the interaction with the users is permitted through both a Graphical and a Command Line Interface. For the Network, a traditional approach based on the use of the Sockets was used.
More information about the game can be found here
Prerequisites
The game requires [Java 8] to run. You can download the SDK from the oracle website.
Features
The features realized following the Project-specific are listed in the following sections:
Features developed
- Complete rules
- CLI
- GUI
- Socket
Advanced features developed
- Multiple Games
- Advanced Gods: Chronus, Hera, Hestia, Triton, Zeus
Docs
The following documentation includes all the significant documents created to show the work behind our project and an insight of our choices. Among this docs there are the UMLs, the Javadoc which describes the code and other useful links and instructions.
UML
The following class diagrams are a representation of the design chosen by our group to implement the game. The initial ones shows the ideas on which we based the project that shape up in the final UML diagrams, divided into a general one and three more detailed ones describing the most critical parts of the design.
- Initial UML Model
- Initial UML Controller and Network
- Final UML
- Final UML Model
- Final UML Network
- Final UML View
JavaDoc
The following documentation includes a description of all of the classes and methods implemented, based on the documentation generator for the Java language, which can be read at this address: Javadoc
Tests with Coverage
To check the proper functioning of the project, a number of tests were executed, the percentages of coverage reached is over 90% for Controller and Model packages, as required from the project specifics. More details are available at the following link: Report Coverage
Built with
Libraries e Plugins
| Libraries/Plugin | Description |
|---|---|
| maven | Project management tool that is based on POM (project object model) |
| junit | Unit testing framework for the Java programming language |
| mockito | Framework for the creation of test double objects (mock objects) in automated unit tests for the purpose of test-driven development |
| JavaFx | Java set of graphics and media packages |
| shade | Plugin which provides the capability to package the artifact in an uber-jar, including its dependencies |
Jars
The following jars have been used for the delivery of the project, they can be used to run the game in accordance with the descriptions given in the introduction. The details on how to run the system will be defined in the section Execution of the jar. The folder which contains Client and Server is at the following address : Jars
Execution of the JAR
Client
In order to correctly run the client jar it is necessary to choose the jar for the Operative System in which it will be ran. The client is executed with the command:
For Macos:
java -jar mac_client.jar
For Windows:
java -jar windows_client.jar
After this line, on the terminal it is asked to the user to choose between the Command Line Interface and the Graphical User Interface (all the dependencies for JavaFx are included); The user will have to type one of this option as a word :
GUI
or
CLI
Please note: in order to have a pleasant experience with the CLI use the full screen.
Server
The execution of the server jar is possible through the following command:
java -jar server.jar
List of Authors:
End
We wish you a safe journey in our virtual world, please have fun and remember to follow the rules! :)