🚀 R-Type

Classic Space Shooter Reimagined

A modern multiplayer remake of the legendary R-Type arcade game, built with cutting-edge C++20 technology and networked gameplay.

Download • Documentation • Report Bug

---

✨ Features

🎮 Gameplay Classic R-Type Action - Authentic arcade experience 4 Player Co-op - Team up with friends online Wave System - Progressive difficulty levels Power-ups - Collect weapons and shields Boss Battles - Epic end-level encounters

⚙️ Technical Multiplayer - Real-time networked gameplay Cross-Platform - Windows & Linux support High Performance - Smooth 60 FPS gameplay Custom ECS Engine - Entity Component System UDP Networking - Low-latency multiplayer

---

🎯 Quick Start

For Players

1️⃣ Download & Install

Requirements:

• Windows 10+ or Linux (Ubuntu 20.04+)
• OpenGL 3.3+ compatible graphics card
• 512 MB RAM
• 100 MB disk space

2️⃣ Run the Game

Windows:

# Start server (host a game)
.\scripts\run_server.bat

# Start client (join a game)
.\scripts\run_client.bat

Linux:

# Start server
./scripts/run_server.sh

# Start client
./scripts/run_client.sh

3️⃣ Configure

Edit config/client/client.toml to customize:

• Graphics - Resolution, fullscreen, VSync
• Controls - Keyboard and gamepad mappings
• Audio - Volume settings
• Network - Server address and port

---

🎮 How to Play

Controls

Action	Keyboard	Gamepad
Move	Arrow Keys	Left Stick
Fire	Space	A Button
Charge Beam	Hold Space	Hold A
Pause	ESC	Start

Game Modes

• 🏠 Host Server - Start a game for others to join
• 🌐 Join Server - Connect to an existing game
• 👥 Multiplayer - Up to 4 players cooperative

---

🛠️ Building from Source

For Developers & Contributors

Prerequisites

• CMake 3.19+
• Ninja build system
• C++20 compiler (GCC 11+, Clang 14+, or MSVC 2022)
• Git with submodules support

Build Steps

# 1. Clone with submodules
git clone --recursive https://github.com/My-Epitech-Organisation/Rtype.git
cd Rtype

# 2. Setup dependencies (first time only)
./scripts/setup-vcpkg.sh

# 3. Configure
cmake --preset linux-release    # Linux
cmake --preset windows-release  # Windows

# 4. Build
cmake --build build --config Release

# 5. Run
./build/bin/r-type_server  # Server
./build/bin/r-type_client  # Client

Advanced Options

# Debug build with tests
cmake --preset linux-debug
cmake --build build
ctest --test-dir build

# Build with documentation
cmake --preset linux-release -DBUILD_DOCS=ON
cmake --build build --target docs

See CONTRIBUTING.md for detailed development guidelines.

---

📚 Documentation

Resource	Description
📖 User Guide	Installation and gameplay instructions
🏗️ Architecture	Technical design and structure
🌐 Network Protocol	Multiplayer protocol specification
🔧 Configuration	Server and client settings
🐛 Troubleshooting	Common issues and solutions

---

🤝 Contributing

We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation:

1. 🍴 Fork the repository
2. 🔨 Create your feature branch (git checkout -b feature/AmazingFeature)
3. ✅ Commit your changes (git commit -m 'Add some AmazingFeature')
4. 📤 Push to the branch (git push origin feature/AmazingFeature)
5. 🎉 Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

---

📊 Project Status

Current Version: 1.0.0
Status: Active Development
Last Updated: January 2026

---

📜 License

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

---

👥 Team

Epitech Project - R-Type 2025/2026

Made with ❤️ by students passionate about game development

---

⭐ Star us on GitHub!

If you enjoy R-Type, consider giving us a star. It helps the project grow! 🚀

⬆ Back to Top