This project is developed as part of the EPITECH Advanced C++ curriculum.
Its primary objective is to design and implement an ECS-based game engine built on a client–server architecture.
The engine is intended to provide a solid foundation for real-time gameplay, efficient communication between components,
and scalable system design.
To showcase and validate the engine’s features, the project includes a full recreation of the classic 1987 game
R-Type.
This recreation serves both as a technical demonstration and as a practical benchmark, ensuring that the engine supports
entity management, networking, rendering, event handling, and other core gameplay mechanics.
Make sure to clone the repository and its submodules:
git clone --recurse-submodules https://github.com/lypitech/rtype.gitThis project uses Conan as its package manager.
You can read how to setup Conan in docs/setup_conan.md.
This project uses CMake as its build system.
# Configure and generate build files
conan install . --output-folder=build/ --build=missing -s compiler.cppstd=23
cmake -B build/
# Compile the project
cmake --build build/If you want the build to be faster (to use all of your CPU cores), simply add --parallel to the options!
You can use the following custom build targets:
| Target | Description |
|---|---|
re |
Rebuilds the project from scratch. |
debug |
Builds the project with debugging symbols and logging enabled. |
Usage example:
cmake --build build --target clean
cmake --build build --target debugYou can run tests by running:
cmake --build build/ --target test
cd build/
ctest --output-on-failureTo play the game, you must launch the Server first, followed by one or more Clients.
Important
The command-line flags defined below are mandatory. Failing to provide them will cause the application to crash.
The server requires a listening port to be specified using the -p flag.
# Syntax
./build/Server/r-type_server -p <port>
# Example: Start server on port 4242
./build/Server/r-type_server -p 4242The client requires both the target host IP (-h) and the target port (-p) to be specified.
# Syntax
./build/Client/r-type_client -h <ip_address> -p <port>
# Example: Connect to localhost on port 4242
./build/Client/r-type_client -h 127.0.0.1 -p 4242
# Example: Connect to a remote server
./build/Client/r-type_client -h 192.168.1.50 -p 4242Once in the game, use the following keys to pilote your ship:
| Action | Key (Keyboard) |
|---|---|
| Move | Arrow Keys |
| Exit | Escape |
Want to play immediately? Follow these steps to build and run a local game.
1. Build the project: Open a terminal in the project root and run:
git clone --recurse-submodules https://github.com/lypitech/rtype.git
cd rtype
conan install . --output-folder=build/ --build=missing -s compiler.cppstd=23
cmake -B build/ -DCMAKE_BUILD_TYPE=Release
cmake --build build/ --parallel2. Run the Server Open a new terminal inside the project root and run this:
./build/Server/r-type_server -p 42423. Run the Client Open another new terminal inside the project root and run this:
./build/Client/r-type_client -h 127.0.0.1 -p 4242Note: You can open multiple terminal to run multiple clients at the same time !
See LICENSE.
louis.persin@epitech.eu
lysandre.boursette@epitech.eu
nathan.jeannot@epitech.eu
pierre.marguerie@epitech.eu
esteban.bouyault-yvanez@epitech.eu