Minesweeper Project

Table of Contents 📚

• Project Description 🕹️
• Project Members 🧔
• Repository Structure 👀
• User story 🧑‍🌾
• How to Run the Game Localy 🚂
• How to Run Project in Eclipse Che 🌐
• Game Rules 📜

Project Description 🕹️

The goal of the project is to make a working minesweeper game. More information about the implementation and the environment setup can be found in Minesweeper README

Members 🧔

• Christian Fredrik Johnsen
• David Tuan Kiet Tran
• Kristian Underdal
• Oskar Emil Wavold

Repository Structure 👀

• pictures/: Contains pictures used in readme-files.
• docs/: Contains all sort of documentation about the project, including the reports after each Release.
• minesweeper/: This is the folder where all of the code for the Minesweeper-game is.
• minesweeper/core: Contains the core logic of the game.
• minesweeper/rest: Contains code for running the REST-server and defines the HTTP methods used.
• minesweeper/ui: Contains code for frontend UI, created with JavaFX.
• minesweeper/appdata: Contains all of the persistent data is. The highscore list is located here.

User Story🧑‍🌾

We have made a story about Truls who is playing minesweeper. Truls' adventure can be read here: user story

How to Run the Game Localy 🚂

1. Navigate to the minesweeper directory

cd minesweeper

2. Install the code

mvn clean install -U

3. Navigate to the rest module

cd rest

4. Start the REST-server

mvn spring-boot:run

5. Navigate to the ui directory

Open a new terminal or split your current which is running the server.

cd minesweeper\ui

6. Run the application

mvn javafx:run

How to Run Project in Eclipse Che 🌐

1. Open the link in a browser

You must have a valid git-token on GitLab and configured a personal access token for Eclipse Che with this git-token.

Open project in Eclipse Che

2. Open a new terminal and navigate to the minesweeper directory

cd minesweeper

3. Run the following command

The tests are running in a separate window. To see them, do step 7.

mvn clean install -U

4. Navigate to the rest module

cd rest

5. Start the REST-server

mvn spring-boot:run

6. Navigate to the ui directory

Open a new terminal or split your current which is running the server.

cd minesweeper\ui

7. Open virtual endpoint

In the left down corner open ENDPOINTS and copy the link from 6080-tcp-desktop-ui (6080/http) and paste it in a new tab.

8. Run the following command

mvn javafx:run

9. Navigate to the game

The game is now running in the other tab with the virtual computer

Game Rules 📜

You can find the overall rules here.

Chording

Chording in this game can be used in a unique way. To use the chording function in this version of Minesweeper, you should first click on a revealed tile. If the number of flags placed around this tile matches the number displayed on the tile itself, you can then press the spacebar. This action will open all the surrounding tiles that have not been flagged.

1. The tile makred with a red circel is clicked
2. The space bar is cllicked