Newer
Older
Welcome to **Wizard**, a C++ implementation of the classic card game. Compete with your friends in exciting multiplayer
gameplay!
This project is part of the *Software Engineering* lecture at *ETH Zurich* in autumn semester 2024. By Marie Becker, Janne Berger, Martina
<div style="display: flex; align-items: center;">
<img src="./assets/cards.png" alt="Cards" style="height: 200px;">
</div>
- 🔄 **Synchronized Game State:** Real-time updates for all players.
- 🖼 **Elegant User Interface:** A visually appealing UI powered by wxWidgets.
---
You can read the game's rules [here](https://blog.amigo-spiele.de/content/ap/rule/06900-GB-AmigoRule.pdf).
The implementation features a client/server architecture for multiplayer scenarios. It uses [wxWidgets](https://www.wxwidgets.org/)
for the GUI, [sockpp](https://github.com/fpagliughi/sockpp) for the network interface, [rapidjson](https://rapidjson.org/md_doc_tutorial.html)
for object serialization, and [googletest](https://github.com/google/googletest) for the unit tests.
The game and source files are available on GitLab on the main branch. The game was developed based on the provided
[LAMA example project](https://gitlab.ethz.ch/hraymond/cse-lama-example-project) game. This project consists of a
**server** and a **client**, each with their own main.cpp file. Each player can run their own client and connect to
a server in the same local network.
This project only works on UNIX systems (Linux / macOS). We thus only explain how to compile and run the game on these
systems. The following description was tested on Ubuntu 24.04 and on macOS Sequoia.
### 2.1 Prepare OS Environment
If your OS does not yet have git installed, install git by running `sudo apt-get install git` on Ubuntu or by
running `xcode-select --install` on macOS (this installs git as well). The Wizard repository can then be cloned by
running `git clone https://gitlab.ethz.ch/beckermar/wizard.git` (clone with HTTPS) or by running
`git clone git@gitlab.ethz.ch:beckermar/wizard.git` (clone with SSH) inside the directory that should contain the game.
Cloning the game as a first step also makes provided scripts for preparing the OS environment and for compiling the code
available.
The necessary packages and software can either be installed manually or by running the provided script.
To use the provided script, run `bash scripts/prepare_ubuntu.sh` inside the **wizard** directory.
To manually prepare Ubuntu, execute the following commands:
1. `sudo apt-get update` (update package list)
2. `sudo apt-get install build-essential` (install software to build from source)
3. `sudo apt-get install libwxgtk3.2-dev` (install wxwidgets, use libwxgtk3.0-gtk3-dev on Ubuntu 20.04 / 22.04)
#### 2.1.2 macOS Sequoia
The necessary packages and software can either be installed manually or by running the provided script.
To use the provided script, run `zsh scripts/prepare_macos.sh` inside the **wizard** directory.
To manually prepare macOS, execute the following commands:
1. `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"` (install homebrew)
2. `brew install cmake` (install cmake)
3. `brew install wxwidgets` (install wxwidgets)
### 2.2 Compile Code
Compiling the code creates executables for the client (Wizard-client) and for the server (Wizard-server).
To use the provided script, run `bash scripts/compile_ubuntu.sh` inside the **wizard** directory.
#### 2.2.1 macOS Sequoia
To use the provided script, run `zsh scripts/compile_macos.sh` inside the **wizard** directory.
---
After compiling the code, navigate into the **cmake-build-debug** directory inside the **wizard** directory. To start a
server, run `./Wizard-server`. In new consoles, you can now start as many clients as you wish by running `./Wizard-client`.
Once a client is started, the connection panel shows up. Here every player can enter the server address and port (in most
cases the default input can be left unchanged), as well as their player name.
If the player name chosen already exists in the game, a number will be automatically added to the name.
Next to these input fields, a *Rules*
button is shown on the bottom right of the screen. The button will be shown throughout the whole game and can be clicked
to access the rules whenever needed.
<img src="/assets/readme/connection_panel.png" width=50% height=50% alt="Connection panel"> <br>
After clicking on the *Connect* button, the lobby shows up. Here all players that have joined the game can be seen. The
*Start Game* button can be clicked to start a game once enough players joined, and the *Leave Game* button can be clicked
to leave the game. This is possible throughout the whole game, however, if a player leaves the game after it has started,
the game is over.
<img src="assets/readme/lobby_one_player.png" width=50% height=50% alt="Lobby panel"> <br>
To start a game, at least 3 players have to connect to the server and join the game. The maximum number of players per
game is 6. Once at least 3 players are connected to the server and have joined the game, the *Start Game* button turns
purple and the game can be started by clicking the button.
If players decide throughout the waiting time that they want to leave the game again, they can press the *Leave Game* button
and leave the Lobby. The player will be removed from the Lobby and the other players can keep waiting.
<img src="assets/readme/lobby_six_players.png" width=50% height=50% alt="Lobby panel"> <br>
Every round starts with an estimation phase. Here each player can enter their trick estimation by typing into the
provided input filed, and then submit it by clicking on the *Submit* button. In this phase of the game, each player can
see their own cards shown at the bottom and the trump card shown on the left side of the screen. The current round number
and the sum of already submitted trick estimations in shown in the middle of the screen and can help players submitting
a valid estimate (e.g., estimate cannot be greater than the current round number).
Above the *Leave Game* button, the
scoreboard can now be accessed by clicking on the *Scoreboard* button.
The scoreboard is available throughout the whole game and winning and loosing players are color-coded.
If a player leaves the game now after it was already started, the game ends immediately for all players
and the final scores are shown to everyone.
<img src="assets/readme/estimation_panel.png" width=50% height=50% alt="Estimation phase"> <br>
After every player has submitted their estimation, the playing phase starts. Cards can be played by clicking on the
respective card. Hovering over cards increases their size to get a closer look.
An announcement in the middle of the screen shows whose turn it is.
The player whose turn it is, is also highlighted in purple. Played cards are displayed in the
middle of the screen as well and in the top left corner the round number and the sum of estimated tricks are shown.
Below each players' name, the won and predicted numbers of tricks can be seen.
<img src="assets/readme/play_phase_last_player.png" width=50% height=50% alt="Play phase"> <br>
At the end of each trick, the winner is shown and the new trick starts automatically. If the trick is the last trick of
a round, also the points gained or lost in this round are shown, and the new round starts automatically. At the end of
the game, the winner is announced and the players can close the game.
## Play on different devices
When playing the game on a single device, the default server address *127.0.0.1* and server port *50505*
can be used during the connection phase.
However, the game can also be played from different devices on the same wifi network 🛜 or if all devices are connected
to the same VPN.
In this case one player needs to host the server, while all other players only run a client.
When connecting to the game, all players have to enter the private IP address of the player hosting the server
in the *server address* field. The default port *50505* can be kept.
### Get local IP address to host server
On macOS version 10.4 throughout the latest version run the following command in the terminal:
```
ipconfig getifaddr en0
```
To host the server the firewall needs to be configured to allow connections on port *50505*.
This can be easiest done by going to `Network settings > Firewall` and turning of the firewall.
On Ubuntu 24.04 you can use the `hostname` command in the terminal:
```
hostname -I
```
The firewall can be configured to allow incoming connections on port *50505* with the following command:
```
sudo ufw allow 50505
```
## Find Coding Documentation
The code in this project was documented via [Doxygen](https://doxygen.nl/).
Doxygen documentation can be accessed by opening the `index.html` file in the `html` folder.
This can be automatically done by running the following command in the terminal out of the `wizard` project folder:
```
open ./html/index.html
```