R-Type

Description

This project is a remake of the R-Type game, a horizontal scrolling shoot'em up game where the player controls a spaceship and has to destroy enemies and obstacles.

This implementation includes new features like networking and multipleyr co-op mode.

Installation

Building from source

To build the project from source, you will need to have the following dependencies installed on your system:

Linux

• Clang & libc++ (LLVM version 18 minimum)
• CMake 3.30 or later
• Ninja 1.11 or later
• Extra SFML build dependencies on Linux (see SFML documentation)

Windows

• Visual Studio 2022 (with MSVC 14.35 minimum)
• CMake 3.30 or later
• Ninja 1.11 or later

Build instructions

First, clone the repository and it's submodules:

git clone https://github.com/Sebabacou-R-type-2027/R-Type.git --recurse-submodules
cd R-Type

Then, run the corresponding cmake workflow:

cmake --workflow --list-presets
Available workflow presets:

  "default"
  "default-llvm"
  "release"
  "release-llvm"

Choose the appropriate preset for your system and build toolchain. For example, to build the project with Clang and libc++ on Linux, use the release-llvm preset, and to build the project with MSVC on Windows, use the release preset.

cmake --workflow --preset=release-llvm
# Install the binaries
sudo cmake --install build --config Release

This will configure, build, test and package the project using the selected preset.

Running the game

Requirements

Before running the game, ensure that you have installed all the required libraries and compiled the project. Once the compilation is successful, follow the instructions below to launch the server and client.

How to Launch the Game

1. Open two terminals and navigate to the same directory (repository) where the executables are located.

2. Run the server in the first terminal using the following command:

   ./r-type_server 8080

   This will start the server on port 8080.

3. Run the client in the second terminal using this command:

   ./r-type_client 127.0.0.1 8080

   This command connects the client to the server running on 127.0.0.1 (localhost) at port 8080.

4. The game will launch, but you will need to return to the client terminal. A prompt will appear:

   $>

5. Login to the game by entering the following command:

   login <username> <password>

   Replace <username> and <password> with your credentials.

6. Create a lobby using the command:

   create_lobby

7. Start the game by typing:

   start

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Feel free to submit a pull request or open an issue for any bug reports, feature requests, or general improvements.