Commit 079a0198 authored by Stefano Grisendi's avatar Stefano Grisendi
Browse files

Update README.md

parent cd545e58
# TDT4240-progark-project
This project was undertaken for the course TDT4240 - Software Architecture. The goal is to develop a game for Android and to get familiar with all that follows; Designing, testing and documenting all aspects related to its Architecture.
We decided do make our own version of the game known as Chinese Checkers. It's a turn based game where every player has to move his pieces on the board. The first player whose pieces all reach the opposite side wins.
### Content of the repository.
We decided do make our own version of the game known as Chinese Checkers. It's a turn based game where every player has to move his pieces on the board. The first player whose pieces all reach the opposite side wins.
The repository includes two Android Studio projects, "CheckersClient" and "CheckersServer". The first contains all the components required to program, build, run and install the Android App for the client-side part, which is the actual game we play on our Android devices. "CheckersServer" allows us to program and set up the server-side part of the game instead.
We believe we achieved this goal as our project works fairly well. Players can join with their custom name, set up their lobbies and once all participants are ready, play the game. There is room for improvment; We wanted to add more customization to the playstyle, like adding powerups, more game modes and more boards. Furthermore there are a few bugs that need to be addressed.
### How to run your server
#### Technologies used
1. Open "CheckersServer" in Android Studio
2. By default we use the port 54555 for TCP, to change this go to core/src/com/mygdx/game/controller/ServerController and change the line server.bind(54555) with the new desired vaule.
3. Hit the run button
The game is developed through Anroid Studio. Both Java and Kotlin are used as programming languages. To simplify the process, we used the libraries [kryonet](https://github.com/EsotericSoftware/kryonet) to create the Client\Server communication sockets and [libGDX](https://github.com/libgdx/libgdx) to set up the game framework.
#### Content of the repository.
The repository includes two Android Studio projects, "CheckersClient" and "CheckersServer". The first contains all the components required to program, build, run and install the Android App for the client-side part, which is the actual game we play on our Android devices. "CheckersServer" allows us to program and set up the server-side part of the game instead.
#### How to configure your server
- Open "CheckersServer" in Android Studio
- By default we use the port 54555 for TCP, to change this go to core/src/com/mygdx/game/controller/ServerController and change the line `server.bind(54555)` with the new desired vaule and save.
#### How to run the applications
To build an APK in Android Studio click "Build" from the top menu and then you select "Build Bundle(s)/Build APK(s)">"Build APK(s)".
Otherwise if you don't want to install the game on your personal device you can use Android studio to run the client and/or server by clicking the run button.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment