Démarrage Rapide

Lancez votre première partie R-Type en 5 minutes !

TL;DR

# Configuration (première fois)
./scripts/build.sh
./scripts/generate_dev_certs.sh  # Certificats TLS

# Compilation + Lancement serveur
./scripts/compile.sh

# Dans un autre terminal : Lancement client (RECOMMANDÉ)
./scripts/compile.sh --client --no-launch && ./scripts/run-client.sh

---

Étape 1 : Compilation

cd rtype

# Configuration initiale (installe vcpkg et configure CMake)
./scripts/build.sh

# Compilation
./scripts/compile.sh --no-launch

Temps de compilation

La première compilation peut prendre plusieurs minutes car vcpkg installe les dépendances.

---

Étape 2 : Lancer le Serveur

Certificats TLS (première fois)

Le serveur utilise TLS pour l'authentification. Générez les certificats de développement :

./scripts/generate_dev_certs.sh

Cela crée le dossier certs/ avec server.crt et server.key.

Lancement

Dans un premier terminal :

./artifacts/server/linux/rtype_server

Ou directement avec le script :

./scripts/compile.sh --server

Sortie attendue :

[INFO] R-Type server starting...
[INFO] Loaded configuration from .env file
[INFO] TCP Auth Server listening on port 4125
[INFO] UDP Game Server listening on port 4124
[INFO] Voice UDP Server listening on port 4126

Configuration du Serveur

Le serveur utilise un fichier .env pour la configuration. Copiez d'abord le fichier exemple :

cp .env.example .env

Puis éditez .env selon vos besoins :

# Ports
TCP_PORT=4125        # Authentification TCP
UDP_PORT=4124        # Game UDP
VOICE_PORT=4126      # Voice chat UDP

# MongoDB
MONGO_URI=mongodb://localhost:27017
MONGO_DB=rtype

Port	Protocol	Usage
4124	UDP	Synchronisation de jeu (snapshots, inputs)
4125	TCP	Authentification, rooms, chat
4126	UDP	Voice chat (Opus)

---

Étape 3 : Lancer le Client

Dans un second terminal :

# RECOMMANDÉ : Via le script wrapper (support voice chat sur Linux/PipeWire)
./scripts/run-client.sh

Pourquoi utiliser le script ?

Le script run-client.sh détecte automatiquement PipeWire et utilise pw-jack pour activer le support du voice chat. Sans ce wrapper, l'audio vocal peut ne pas fonctionner sur les systèmes Linux modernes.

Alternative (compilation + lancement) :

./scripts/compile.sh --client

Ou binaire direct (voice chat peut ne pas fonctionner) :

./artifacts/client/linux/rtype_client

Options du Client

Option	Description	Défaut
--server=<host>	Adresse du serveur	127.0.0.1
--graphics=<name>	Backend graphique (sdl2 ou sfml)	sfml
--graphics-path=<path>	Chemin vers un plugin graphique custom	-
-h, --help	Afficher l'aide	-

Connexion à un serveur distant

Utilisez l'option --server : ./scripts/run-client.sh --server=51.254.137.175

---

Étape 4 : Jouer !

Contrôles

Touche	Action
Up Down Left Right	Déplacement
Space	Tir
V	Voice Chat (Push-to-Talk)
T	Ouvrir le chat
Esc	Fermer le chat

---

Mode Multijoueur

Héberger une Partie

# Sur la machine hôte
./artifacts/server/linux/rtype_server

Rejoindre une Partie Distante

# Via le script (RECOMMANDÉ)
./scripts/run-client.sh --server=<IP_HOTE>

# Exemple avec le serveur France
./scripts/run-client.sh --server=51.254.137.175

Le serveur écoute sur les ports : - 4124 (UDP) : Game - 4125 (TCP) : Auth - 4126 (UDP) : Voice

Communiquez votre IP publique aux autres joueurs et ouvrez ces ports sur votre routeur.

Rejoindre une Partie Distante

Utilisez l'option --server pour vous connecter à un serveur distant :

# Via le script (RECOMMANDÉ - support voice chat)
./scripts/run-client.sh --server=<IP_HOTE>

# Exemple
./scripts/run-client.sh --server=51.254.137.175

---

Schéma de Démarrage

sequenceDiagram
    participant S as Serveur
    participant C1 as Client 1
    participant C2 as Client 2

    S->>S: Démarrage (TCP:4125, UDP:4124)
    C1->>S: Login (TCP)
    S->>C1: LoginAck + SessionToken
    C1->>S: CreateRoom (TCP)
    S->>C1: CreateRoomAck + RoomCode
    C2->>S: Login (TCP)
    S->>C2: LoginAck + SessionToken
    C2->>S: JoinRoomByCode (TCP)
    S->>C2: JoinRoomAck
    S->>C1: RoomUpdate (Player 2 joined)
    Note over S,C2: Host starts game
    C1->>S: JoinGame (UDP + Token)
    C2->>S: JoinGame (UDP + Token)
    S->>C1: JoinGameAck (player_id)
    S->>C2: JoinGameAck (player_id)
    loop Game Loop (20Hz)
        C1->>S: PlayerInput (keys bitfield)
        C2->>S: PlayerInput (keys bitfield)
        S->>C1: Snapshot (all players, missiles, enemies)
        S->>C2: Snapshot
    end

---

Prochaines Étapes

⚙️ Configuration

Personnalisez les paramètres du jeu.

🎨 Backends Graphiques

Choisissez entre SDL2 et SFML.