Welcome to Tetris Royale, a modern multiplayer version of the classic Tetris game. This project is developed using C++ and CMake, and it incorporates a range of libraries such as FTXUI, Boost, Qt5, and others to provide an immersive and scalable gaming experience.
In-game view and lobby browser
For further details, please refer to the following documents:
- Battle Royale: Play against up to 8 other players in real-time!
- Modern C++: Developed with modern C++ features, following an Object-Oriented Programming (OOP) approach.
- Cross-Platform: The project is designed to be cross-platform, allowing you to build and run it on various platforms (i.e. MacOS, Unix, Termux) using CMake.
- Cross-Interface: The client can be launched either in a terminal or with a graphical user interface (GUI) for a better experience.
Ensure you have CMake and a C++ compiler installed on your system, as well as the unzip and curl packages.
Qt5 also needs to be pre-installed. You can install it with your package manager, such as apt or pacman.
To get Tetris Royale up and running on your machine, you must use the install.sh installation script:
sh ./install.shThis should install all the dependencies, launch the CMake and the Makefile to build the project. If this fails, you might want to use the Manual Installation Guide for this part.
To install Tetris Royale on your machine, follow these steps:
Start by cloning the project repository to your local machine:
git clone https://gitlab.ulb.be/infof209/2024-25/group-1
cd ./group-1Ensure you have CMake and a C++ compiler installed on your system. You can use the provided script to automatically install the required dependencies:
sh ./scripts/find_dependencies.shThis script will install any necessary libraries and tools for the project. You will then need to set up the environment to let the CMake know where your dependencies are:
sh ./lib/setup-env.shCreate a build directory and configure the project using CMake. Then, compile the project using make:
mkdir build
cd build
cmake ..
makeThis will generate the project files and compile the source code into executable binaries.
After successfully building the project, you can run Tetris Royale as either the server or client:
-
For Server (to host the game):
sh ./bin/TetrisRoyaleMasterServer
-
For Client (to connect to the server and play):
sh ./bin/TetrisRoyaleClientTUI # Terminal version sh ./bin/TetrisRoyaleClientGUI # GUI version
This project is licensed under the MIT License. See the LICENSE file for more details.
To ensure the project works as expected, you can run the unit tests included in the repository. Follow these steps to enable and execute the tests:
When running the install.sh script, include the --enable-tests flag to enable the tests:
sh ./install.sh --enable-testsThis will configure the project to include the test suite during the build process.
After the build is complete, navigate to the build directory and run the tests using ctest:
cd build
ctest --output-on-failureThis will execute all the tests and display detailed output for any failures.
If you prefer to configure the tests manually, you can enable them directly with CMake:
mkdir build
cd build
cmake -DTETRIS_ENABLE_TESTS=ON ..
make
ctest --output-on-failureThis approach gives you more control over the build process.
This project was developed for the Projet d'informatique 2 course INFO-F209. Special thanks to Alexis Reynouard (ULB), Simon Renard (ULB) and Hugo Callebaut (ULB) for their guidance and support.
Antoine Berthion — 566199([email protected])Ali Umar Babar — 587669([email protected])Ayman Benaim — 540166([email protected])Mamadou Barry — 570893([email protected])Roberto Rabei — 593814([email protected])Rares Bors — 567744([email protected])Oleksandra Omelyanyuk — 589880([email protected])Taha Es-saâdouni — 573602([email protected])