The Mind

Table of Contents

1. About The Project
2. Context
3. Built With
4. Documentation
5. Getting Started
6. Usage
7. Contributors
8. Acknowledgments

About The Project

This project basic principle is: a simple version of the existing card game The Mind playable in multiplayer (in LAN or Internet) and with bots.

To give a brief idea of the game, it is a game in several rounds. In the first round, each player receives a card with a number between 1 and 100. Each player must play the cards in ascending order, from the smallest to the largest, otherwise the round is lost, so the game is cooperative. Be careful, no player is allowed to communicate either verbally or physically, hence the difficulty.

We have slightly modified the original game, to add three lives, when a round is lost, a life is lost. There is no limit to the number of rounds.

Features

• Playable with up to 20 players and bots.
• Stats generation in a PDF file at game end.

(back to top)

Context

This project is an academic project made during the third year of a Bachelor of Computer Science.
The development was done by 2 people.

(back to top)

Built With

Entire project was built with C and is only compatible with Linux.

(back to top)

Documentation

You can find documentation such as technical details, instructions, and UML diagrams in the folder docs/.
Moreover, Doxygen docs can be generated in HTML with script file src/Doxy/run_doxygen (Doxygen must be installed on your system).

(back to top)

Getting Started

To get a local copy up and running follow the steps:

Prerequisites

To compile the project, you will need:

• Make
• CMake

apt-get install make
apt-get install cmake

To execute the project, you will need:

• TeX Live

apt-get install texlive-latex-base
apt-get install texlive-latex-extra
apt-get install texlive-lang-french

Optional dependency:

apt-get install doxygen

Installation

1. Clone the repo:

   git clone https://github.com/Akwd22/the-mind.git

2. Compile the project:

   cd src
   cmake .
   make

(back to top)

Usage

To play the game, you have to run a server (game), while clients (human players) connect to it.

1. Start the server: run the executable src/ServerProject/ServerProject.
2. Start one or more clients (on the same machine or not): run the executable src/ClientProject/ClientProject.
   On the login screen, you must type the IP address (127.0.0.1 if the server is on the same machine) and port 25565 of the server to connect.

Note: if you want to play on the Internet, you must open the TCP port 25565 on your firewall.

(back to top)

Contributors

This project was made by:

• Eddy D.
• Clément G.

(back to top)

Acknowledgments

• Simple Dynamic Strings library for C

(back to top)