Skip to content

Latest commit

 

History

History
88 lines (66 loc) · 2.36 KB

README.md

File metadata and controls

88 lines (66 loc) · 2.36 KB
Raw

R-Type

R-Type is a horizontal-scrolling shooter arcade game developed and published by Irem in 1987. This project aims to recreate a similar game with multiplayer capabilities.

Table of Contents

Click to expand
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributors
  5. License

About The Project

R-Type is a horizontal-scrolling shooter arcade game developed and published by Irem in 1987. The player controls a space fighter named the R-9 to defend humanity against a mysterious powerful alien life-form known as the Bydo.

The goal of this project is to recreate a game similar to R-Type with multiplayer capabilities. The challenges are to create a standalone game engine that can handle multiple players using the UDP protocol and to create a game that is fun to play.

Getting Started

Dependencies/Requirements

  • C++20
  • Raylib 5.0 # fetch automatically if not found
  • CMake 3.10 or higher

Supported Platforms

  • Windows
  • macOS
  • Linux

Build Instructions

Linux

  1. Clone the repository:
  2. Build the project using CMake:
./scripts/build.sh

Windows

  1. Clone the repository:
  2. Open powershell
  3. Build the project using CMake:
.\scripts\build.ps1

If you can't run the script because of the execution policy, you can change it with the following command:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

Usage

Server

./r-type_server [port]
./r-type_client [ip] [port]

Documentation

The documentation is available in the docs folder. You can read it here. use mdbook to open the documentation in your browser:

mdbook serve docs --open

Contributors

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)