R-Type

A multiplayer shoot 'em up game inspired by the classic R-Type series.

Table of Contents

• About the Project
• Features
• Getting Started
  • Prerequisites
  • Installation
• Documentation
• Technologies Used
• License
• Contact
  • Team Members
• Acknowledgments

About the Project

The R-Type Project is a modern take on the classic arcade game R-Type, featuring multiplayer capabilities and enhanced graphics. Players can team up to fight against waves of enemies and challenging bosses in a side-scrolling shooter environment.

The application is divided into two parts:

• Game server to handle the game logic and multiplayer interactions.
• A desktop client to provide a user interface for playing the game.

Features

• Multiplayer Support: Play with friends in cooperative mode.

• Nostalgic Graphics: Pixel art visuals to retain the classic feel.

• Boss Battles: A challenging boss with two attack phases.

Getting Started

Follow these instructions to get a copy of the project on your local machine.

Prerequisites

• CMake: For managing the build process.
• Make: For building the project.
• Conan: For dependency management.
• C++: The programming language used for development.

Installation

1. Clone the repository:

   git clone https://github.com/ItsZcx/r-type.git

2. Navigate to the project directory:

   cd r-type

3. Set up environment variables:

   make install

Usage

To run the project, you can use the provided Makefile which includes commands to build and run both the server and the client.

1. Build the project:

   make build

2. Run the server:

   ./server [PORT]

3. Run the client:

   ./client

When you run the client, it will prompt you to enter the server IP. If you are running both the server and client on the same machine, provide the IP in the format 127.0.0.1:PORT. Otherwise, provide the appropriate server IP and port.

Documentation

For more detailed information, refer to the following documents in the ./docs folder:

• DEVELOPER.md
• ARCHITECTURE.md
• PROTOCOL.md

Technologies Used

General:

• C++: The programming language used for development.
• Make: For building the project.
• CMake: For managing the build process.
• Conan: For dependency management.
• clang-format: For code formatting.

Networking:

• Asio: For asynchronous networking.

Graphics:

• SFML: Simple and Fast Multimedia Library for graphics and audio. (You might have to install this manually)

License

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

Contact

Team Members

• Joan Pau Mérida Ruiz: Game Engine/System Developer (GitHub, LinkedIn, Email)
• David Salvatella Gelpi: Game Engine/System Developer (GitHub, LinkedIn, Email)
• Alex Arteaga Contijoch: DevOps, Project Manager (GitHub, LinkedIn, Email)
• Matheus López: Gameplay Programmer (GitHub, LinkedIn, Email)
• Mario Alessandro: Gameplay Programmer (GitHub, LinkedIn, Email)

Acknowledgments

• This project was inspired by the classic R-Type game series.