SetupRTypeProject.md

R-Type Project Setup

Prerequisites

Before you begin, ensure you have met the following requirements:

• You have a Windows, macOS, or Linux machine.
• You have installed Git.
• You have installed CMake.
• You have installed a compatible C++ compiler (e.g., GCC, Clang, MSVC).

Setting up vcpkg

vcpkg is a C++ library manager that simplifies library management for C++ projects.

Step 1: Clone vcpkg

First, you need to clone the vcpkg repository:

git clone https://github.com/microsoft/vcpkg.git
cd vcpkg

Step 2: Bootstrap vcpkg

Next, you need to bootstrap vcpkg:

• On Windows:

  .\bootstrap-vcpkg.bat

• On macOS and Linux:

  ./bootstrap-vcpkg.sh

Step 3: Integrate vcpkg with CMake

Run the following command to integrate vcpkg with CMake:

./vcpkg integrate install

This command makes the vcpkg toolchain automatically available for all CMake projects that use it.

Step 4: Install Dependencies

With vcpkg set up, you can now install the necessary dependencies for the R-Type project. Ensure you are in the vcpkg directory:

./vcpkg install [list-of-dependencies]

Replace [list-of-dependencies] with the actual list of dependencies specified in your vcpkg.json file.

Setting up the R-Type Project

Step 1: Clone the R-Type Repository

First, clone the R-Type project repository:

git clone https://git.jetbrains.space/roumite/r-type/R-Type.git
cd r-type

Step 2: Configure and Build the Project

Create a build directory and run CMake with the vcpkg toolchain file:

mkdir build
cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../vcpkg/scripts/buildsystems/vcpkg.cmake
cmake --build .

This will configure the project to use vcpkg for dependency management and then build the project.

Additional Resources

• vcpkg Documentation
• CMake Documentation
• R-Type Project Documentation (if available)

---

Installing Required Tools

On Debian and Ubuntu derivatives:

sudo apt-get install curl zip unzip tar

On recent Red Hat and Fedora derivatives:

sudo dnf install curl zip unzip tar

On older Red Hat and Fedora derivatives:

sudo yum install curl zip unzip tar

On SUSE Linux and derivatives:

sudo zypper install curl zip unzip tar

On Arch Linux and derivatives:

sudo pacman -Syu base-devel git curl zip unzip tar cmake ninja

On Alpine:

apk add build-base cmake ninja zip unzip curl git
```                                                                                 sudo apt-get install curl zip unzip tar                                                                               On recent Red Hat and Fedora derivatives:                                                                                 sudo dnf install curl zip unzip tar                                                                                   On older Red Hat and Fedora derivatives:                                                                                  sudo yum install curl zip unzip tar                                                                                   On SUSE Linux and derivatives:                                                                                            sudo zypper install curl zip unzip tar                                                                                On Arch Linux and derivatives:                                                                                            sudo pacman -Syu base-devel git curl zip unzip tar cmake ninja                                                        On Alpine:                                                                                                                apk add build-base cmake ninja zip unzip curl git