R-Type

R-Type is a side-scrolling shooter game inspired by the classic arcade experience. You control a spaceship, fighting enemy waves and bosses, aiming to survive and advance through stages.

Features

• Networked coop mode
• Easy behavior scripting
• Power-ups and ship upgrades
• Updated graphics and sound, with a retro feel

Usage

• Use arrow keys or WASD to move.
• Shoot with Space or Ctrl.
• Avoid enemy fire and collect power-ups.
• Defeat bosses to progress.

Windows

Warning

Windows binary provided by the Github releases are still an experimental feature. Please for windows build the game from source

1. Download the latest release from GitHub Releases.
2. Extract the zip file.
3. Run

   r-type.exe -i <SERVER_IP> -p <SERVER_PORT>

Linux

1. Download the latest release from GitHub Releases.
2. Extract the archive.
3. Open a terminal in the extracted folder.
4. Run:

   ./r-type -i <SERVER_IP> -p <SERVER_PORT>

macOS

macOS is not officially supported, but you can try building from source (see below).

Running a server

You can run a server using the r-type_server executable. You need to provide a port to bind to and the number of rooms, for example:

./r-type_server -p PORT -r NBROOMS

Clients can then connect to your server using the game client.

./r-type -i IP -p PORT

The server is always available on Windows, you just need to adapt the above commands to make it work.

Support & Feedback

Please report issues or suggestions via GitHub Issues.

Documentation

The comparative study is available here, and the network protocol can be found here.

License

See LICENSE for details.

Building from Source

Recommended: Using the Justfile

Note: this step only works on Linux, for Windows please use the instructions in "Manual Build on Windows". If you have just installed, simply run :

just release

Manual Build on Linux (CMake)

If you do not wish to use just, you can build manually:

1. Clone the repository:

   git clone https://github.com/dawpitech/r-type.git
   cd r-type

2. Create the build directory and run CMake:

   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

3. Build the project:

   cmake --build build -j$(nproc)

Manual Build on Windows (CMake & Visual Studio)

1. Download and install CMake for Windows

2. Download Visual Studio 2022 Community Edition and install the C++ toolchain from the installer.

3. Clone the repository:

   git clone https://github.com/dawpitech/r-type.git
   cd r-type

4. Create the build directory and run CMake:

   cmake -S . -B build -DCMAKE_BUILD_TYPE=Release

5. Build the project:

   cmake --build build --config Release -j%NUMBER_OF_PROCESSORS%