SoPra FS23 Group 40 - TacBlock

Introduction

Motivation

Our idea was to create a game that would be fun to play, which keeps us motivated for the whole semester. We decided to create "TacBlock", which is similar as the original game "Blokus" from Bernard Tavitian, but as a nice online game version.

Game Mechanism

The game is played by 4 players, who have to place their blocks on the board. The goal is to place as many blocks as possible. The game ends when no player can place any more blocks on the board. The winner is the player with the most blocks on the board. You can find a "Rules" section in the game, which explains the game in more detail.

Technologies

We use Java as the main programming Language for the Server.
With REST endpoints, the Clients can interact with the Server, which is programmed with Spring.
We use JPA for persistance.
The Server is built with Gradle.
Both Server and Client are deployed on Google Cloud and the code is stored GitHub.
SonarCloud checks our code every time we push to GitHub and deploy it.

For the Client's technologies, please refer to the Client's README.md.

High-level components

GameController, LobbyController, UserController for REST Endpoints
Game for the game logic
UserService for the user creation and handling

Launch & Deployment

How to run the application

Clone the repository and navigate in the terminal to its location
With the command ./gradlew build, the project will be built
Alternatively, you can right-click the build.gradle in your IDE and select "Build Module 'Server'".
With the command ./gradlew bootRun, the project will be run
Alternatively, you can right-click the build.gradle in your IDE and select "Run 'Server'".
The server is now running on localhost:8080
- To run only the tests, use the command ./gradlew test
- To exclude tests when building, use the command ./gradlew build -xtest

How to deploy the application

To deploy the application, push it to the main branch of the GitHub repository.
The application will be automatically deployed on Google Cloud and checked by SonarCloud.
The server is now deployed on http://sopra-fs23-group-40-server.oa.r.appspot.com.
(the Client will be deployed on http://sopra-fs23-group-40-client.oa.r.appspot.com)

Please note that Google Cloud checks are very strict. It is possible that the deployment fails for example because of unused import statements, so make sure to chat that beforehand.

Illustrations

1. Login & Registration

Login

Registration

2. Rules

3. Finding & Creating a Lobby

Lobby Overview

Lobby

4. Playing the game

Welcome Information

Empty Board

No moves possible

Ingame Rules

Resigning from placing blocks

Leaving the game

5. Game over screen

6. Statistics

Roadmap

Possible features for the future:

a game version with less than 4 Players (or more).
the players can see the other players' moves in real-time
a rating / ELO system
a chat in the lobby or game
a game history in the statistics
the possibility to play against a computer/AI
the functionality to see another player's profile/statistics

Authors and Acknowledgment

Authors

thomi100
Karo2222
turbodumba
PaulPerpetual
jverho
Group's Coach / Teaching Assistant luis-tm

no acknowledgements

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sopra-fs23-group-40 / Server

readme