README.md

R-Type

Contents

• Requirements
• Communication
• Installation
• Installation from source
• Compilation
• More Details
• Testing
• Credits
• License

Requirements

• C++ 20+ is required

Communication

• If you have a bug or an issue, please contact us.

Installation

• Head to the releases page and download the latest release for your platform.

Installation from source

SSH

git clone git@github.com:UwUClub/R-Type.git

Compilation

Using CMake

cmake -S . -B build && cmake --build build

Binaries

Server

First start the server

./server <ip> <port>

Client

Then start the client

./client <ip of server> <port of server>

Flappybird

Standalone flappybird game to demonstrate ECS.

./flappybird

More Details

• Dependency Setup
• Building Details
• 

   can add that to see coverage % in github
   * [![codecov](https://codecov.io/gh/UwUClub/R-Type/branch/main/graph/badge.svg)](https://codecov.io/gh/cpp-best-practices/cmake_template)

Testing

See Catch2 tutorial

Credits

• Valentin Gegoux
• Baptiste Laran
• Mathéo Martin
• Maxence Labourel

License

R-Type is developped by the UwUClub for Epitech.