Développement

Cet article vous introduit au développement de DDNet. En tant que jeu à sources ouvertes, il repose sur la générosité et le temps libre des contributeurs.

Environnement de développement

Il est recommandé de développer dans un environnement Linux pour les raisons suivantes:

la plupart des contributeurs utilisent Linux;
gestion des paquets plus aisée, vous pouvez facilement installer les librairies requises;
cet article n'a pas encore de version Windows et se concentre sur Linux.

DDNet est écrit en langage C++ et vous devez en avoir une bonne connaissance mais vous pouvez aussi en connaître les bases et apprendre en développant pour DDNet.

Quelques ressources de développement utiles:

cppreference.com (référence C++ en anglais pour utilisateurs avancés)
openclassrooms.com (bases, contient de la publicité, peut être limité en termes de pages par jour)
openclassrooms.com (programmation orientée objet, contient de la publicité, peut être limité en termes de pages par jour)
developpez.com (liste de tutoriels)

Le code source de DDNet est géré par Git, un outil de versionnage. Vous pouvez l'installer dans la majorité des distributions basées sur Ubuntu/Debian : sudo apt install git.

Obtenir le code source

Le code source se trouve sur Github. Vous pouvez le récupérer en clonant le répertoire sans compte : git clone --recursive https://github.com/ddnet/ddnet.git. Cependant, vous devrez avoir un compte pour proposer vos modifications à la communauté.

Quelques ressources pour apprendre Git:

Hello World - Github (en anglais)
openclassrooms.com

Installer les dépendances

Sous Linux, vous pouvez installer les dépendances nécessaires en lisant le fichier README du répertoire github de DDNet: https://github.com/ddnet/ddnet#dependencies-on-linux--macos.

Compiler DDNet

Nous utilisons CMake pour gérer la compilation. Une fois que toutes les dépendances sont installés (incluant CMake), vous pouvez exécuter les commandes suivantes depuis le répertoire DDNet:

mkdir build && cd build
cmake ..
make -j$(nproc)

Informations générales

Actuellement, le code est compilé avec le standard C++17 mais vous constaterez que la majeure partie du code est plus proche du C et seul le nouveau code utilise des parties du standard C++17.

std::string est rarement utilisée. Les tableaux de caractères et l'utilisation des méthodes de system.h sont la norme.

Tout ce qui est E/S, formatage et affichage est réalisés en utilisant les méthodes de system.h.

Disposition du code source

Répertoire src/base

Comme DDNet est un jeu multi-plateforme, une couche d'abstraction est nécessaire pour un développement plus aisé. Ce répertoire contient les fonctions utiles pour tout ce qui touche au système d'exploitation.

Répertoire src/engine

Ici se trouve le moteur de jeu qui gère tout ce qui n'est pas lié à la jouabilité, à savoir les graphismes, le son, le réseau, etc.

Répertoire src/game

Tout ce qui concerne la jouabilité, séparé entre client et serveur, incluant la physique du jeu et l'interface graphique du client.

Serveur

Le jeu repose sur un ensemble de composants qui dérivent tous de la classe mère CEntity définie dans src/game/server/entity.h. Ces entités sont gérées par la classe CGameWorld définie dans src/game/server/gameworld.h.

Quelques entités importantes:

CCharacter qui représente un Tee vivant. Elle est instanciée quand un tee apparaît et supprimée quand il meurt.
CPlayer contient les informations non liées au Tee (pseudo, drapeau, etc.).

Client

Le client est lui aussi constitué de composants qui sont tous des classes dérivées de CComponent définie dans src/game/client/component.h. Ces composants peuvent implémenter les méthodes virtuelles OnInit, OnMessage, etc. pour fournir leurs fonctionnalités.

Réseau

Le protocole réseau est généré par des scripts Python qui génèrent le code C++. Par exemple, le fichier datasrc/network.py définit tous les paquets réseaux.

Convention de code

La discussion pour les conventions d'écriture se trouve ici: ddnet#2945

Actuellement, ce qui suit s'applique.

Indentation

Le style d'Allman est utilisé.

while (x == y)
{
    Something();
    SomethingElse();
}

Finalthing();

Classes et structures

Toutes les classes et structures doivent être précédées par un C ou un I pour les interfaces. Pour des raisons historiques, certaines structures ne l'ont pas comme dans la partie graphique.

Exemple:

class CCharacter : public CEntity
{
    // ...
}

Énumérations et constantes

Elles doivent être écrites en notation snake case [1] (i.e. tout en majuscules). Par example: MAX_PLAYERS

enum
{
	FAKETUNE_FREEZE = 1,
	FAKETUNE_SOLO = 2,
	FAKETUNE_NOJUMP = 4,
	FAKETUNE_NOCOLL = 8,
	FAKETUNE_NOHOOK = 16,
	FAKETUNE_JETPACK = 32,
	FAKETUNE_NOHAMMER = 64,
};

Convention de nommage

Le nom des variables doit contenir 3 parties: le qualificatif, le préfixe et le nom. Les noms doivent commencer par une majuscule à moins qu'elle ne soit de longueur unitaire sans aucun qualificatif ou préfixe, par exemple les variables de boucle i et j. Les noms des variables doivent être écrits en anglais et suivent la convention camel case [2] (i.e. majuscule à chaque mot). Les variables peuvent avoir plus d'un qualificatif ou plus d'un préfixe.

Ils sont disposés de la manière suivante: [qualificatifs]_[préfixes][Nom].

Qualificatifs

m pour les variables membres: m_MyVariable
s pour les variables statiques: s_MyStaticVariable
g pour les variables globales : gs_MyGlobalStaticVar

Préfixes

p pour les pointeurs: pMyPointer, m_pCharacter, ppMyPointerToPointer
a pour les tableaux : aMyArray[MAX_PLAYERS], aBuf
fn pour les fonctions: pfnMyCallback, m_papfnMyPointerToArrayOfCallbacks

Exemples courants

Formatage de texte

char aBuf[128];
str_format(aBuf, sizeof(aBuf), "number: %d", 2);

Itérer tous les joueurs

for(int i = 0; i < MAX_CLIENTS; i++)
{
    // Server-side
    CPlayer *pPlayer = GameServer()->m_apPlayers[i];
    if(pPlayer == nullptr)
        continue;
    // do something with pPlayer
}

Afficher dans la console de jeu

Console()->Print(IConsole::OUTPUT_LEVEL_STANDARD, "wikiprint", "Hello from the ddnet wiki!");

Affichage de débogage

int i = 2;
dbg_msg("wikiprint", "Hello from the ddnet wiki: %d", i)