https://github.com/miou-zora/r-type
This project is a reproduction of "R-Type" game using a custom game engine (ECS) and up for 4 players in a same room.
https://github.com/miou-zora/r-type
cpp17 cross-platform ecs game linux network r-type windows
Last synced: about 2 months ago
JSON representation
This project is a reproduction of "R-Type" game using a custom game engine (ECS) and up for 4 players in a same room.
- Host: GitHub
- URL: https://github.com/miou-zora/r-type
- Owner: Miou-zora
- Created: 2023-11-23T22:05:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-23T22:25:29.000Z (over 2 years ago)
- Last Synced: 2025-03-26T10:12:19.412Z (about 1 year ago)
- Topics: cpp17, cross-platform, ecs, game, linux, network, r-type, windows
- Language: C++
- Homepage:
- Size: 6.05 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# R-Type
[R-Type](https://fr.wikipedia.org/wiki/R-Type_(jeu_vid%C3%A9o)) is a classic side-scrolling shoot 'em up video game with a cooperative multiplayer feature. In this game, players can team up with a friend to control small spacecraft as they navigate through a series of challenging levels filled with various enemy spacecraft and obstacles. The objective is to defeat the waves of enemies and powerful bosses while avoiding their attacks, and this cooperative multiplayer mode allows players to work together to overcome the game's challenges, making it even more enjoyable as a team.
This is an [Epitech](https://www.epitech.eu/) project involving the development of a network game with an [ECS (Entity Component System)](https://github.com/Miou-zora/R-Type/wiki/Librairies).
## How to build ?
### Linux
#### Requirements
- g++
- make
- cmake
Install them with the following command if needed :
```bash
sudo apt install g++ make cmake
```
For WSL users : some desktop system librairies are required. They are usually installed with the desktop environments on many Linux distributions which is not the case on WSL. You can install them with the following command :
```bash
sudo apt install libxinerama-dev libxcursor-dev xorg-dev libglu1-mesa-dev pkg-config
```
#### Build
The build script will automatically install the dependencies using vcpkg and build the project. Vcpkg will be installed in the project directory.
```bash
./build.sh
```
### Windows
#### Requirements
MSVC Build Tools are required. We recommend to install them along Visual Studio 2022.
See [this page](https://visualstudio.microsoft.com/fr/downloads/) for download links.
You will also need to run the command in the Developer Command Prompt for VS.
#### Build
The build script will automatically install the dependencies using vcpkg and build the project. Vcpkg will be installed in the project directory.
```cmd
.\build.bat
```
## How to run ?
Executables will be compiled at the root of the project directory, unter the names `rtype_server` and `rtype_client` (+ `.exe` on Windows). You can run them simply by running the executables.
## How to play ?
Launch the client and enter the **server's IP address**, then click on **Start**.
Then choose your preferred game mode.
If you choose **join game**, be sure to enter a room that has already been created by another player.\
To play, use your **keyboard arrows** to move around, and the **space bar** to fire missiles. You only have 10 lives!
The game ends once all players are dead, or you've beaten the final boss.\
**Enjoy the game!**
## More informations ?
Go to [this wiki](https://github.com/Miou-zora/R-Type/wiki), the project will be detailed more technically, enjoy!
## Contributors
| 
| 
| 
| 
|
| --- | --- | --- | --- |
| [Miou-zora](https://github.com/Miou-zora) | [Ripel2](https://github.com/ripel2) | [Queng123](https://github.com/Queng123) | [FoxaxeWasTaken](https://github.com/FoxaxeWasTaken) |