/R-Type

EPITECH 3rd year project which involves recreating the game R-Type alongside a game engine in C++.

Primary LanguageC++GNU General Public License v3.0GPL-3.0

R-Type

License GPL 3.0 Repo Size Release Github stars

Platform Windows Platform Linux

This project involves building a game engine.
To show the use of it we have reproduced three game:

  • Solo R-Type
  • Networked R-Type
  • Physical demo (a little reproduction of Flappy bird)

Project architecture

Project architecture The project is divided into four main parts:

  • Runtime
  • Editor
  • Client
  • Server

Runtime: It is this part which contains the game engine and the network lib.
Editor: With this project, create your own games easily thanks to an easy and easy-to-use graphical interface! How to use editor
Client: If you're creating a network game, use our client so you can connect directly to your server! How to use client
Server: Every network game must have a server managing the players ! How to use server

Wiki

You can find all informations about this project on our wiki.

How to install

For non developer/user

You can download the latest installer, for windows or linux here.

This installer contains Server, Client, Editor & Runtime (obviously) !

For developer

Firstly you need to install vcpkg and set the VCPKG_ROOT environnement variable to the directory where you installed vcpkg. The steps depends on your operating system.

Then you can do as follow:

mkdir build
cmake --preset=default -S . -B ./build/
cmake --build ./build/
cd build

# to launch the client
./rtype_client          # with a .exe at the end on Windows

# to launch the editor
./rtype_editor          # with a .exe at the end on Windows

# to launch the server
./rtype_server          # with a .exe at the end on Windows

If vcpkg is not found, you might need to add the path to vcpkg to the PATH environnement

If you want to build release:

mkdir build
cmake -S . -B build --preset=release
cd build
cmake --build . --config Release

What is difference between default and release ?
The default preset builds the project in debug mode, allowing easier debugging. However, this mode can cause slowdowns in the runtime.

For a release version, use the release preset!

How to play to our RType ?

To play to our game, you need to put content of the r-type-game folder on the same folder of server/client you want to launch.
Then, you just have to launch the server/client to be able to play!

How to use client ?
How to use server ?

Authors

Sinan KARAKAYA: Runtime/Editor - sinan.karakaya@epitech.eu
Lucas DUPONT: Runtime/Network - lucas1.dupont@epitech.eu
Jovan HILLION: Runtime/Scripting/RType Game - jovan.hillion@epitech.eu
Jason LAGOUTE: Network/Server - jason.lagoute@epitech.eu
Mathis LE BONNIEC: Client/Editor - mathis.le-bonniec@epitech.eu