Présentation et installation de Godot Engine 3.0 C# : Godot Engine

Avec l'émergence de moteurs de jeu puissants et accessibles tels que Unity3D, le développement de jeu s'est beaucoup démocratisé ces dernières années. Aujourd'hui, nous allons parler d'un moteur libre qui monte en ce moment : Godot Engine. Ce moteur est une alternative open-source et plus que crédible au moteur Unity. Dans ce tutoriel, je vous présenterai rapidement le Godot Engine 3.0 ainsi que la méthode d'installation sur Windows, MacOSX et Linux. Si vous savez déjà ce qu'est le Godot Engine, je vous encourage à passer directement à la section "Installation" disponible plus bas. C'est parti !

Godot Engine 3.0

Présentation

Godot Engine est un moteur de jeu libre publié sous licence MIT. Entendez par là qu'il est 100% gratuit en version complète, open-source, et vous permet de créer un jeu qui vous appartient complètement sans aucun problème de droit. C'est déjà un gros point fort mais ce qui distingue particulièrement Godot d'autres moteurs disponibles sous les mêmes termes est sa puissance et sa facilité d'utilisation. Cette particularité fait qu'on a tendance à le comparer (un peu rapidement) à Unity3D. De nombreux comparatifs ont vu le jour sur le web pour faire le point sur les atouts et les désavantages des deux moteurs mais nous n'en parlerons pas ici. Contentons-nous de dire que Godot est largement à la hauteur de son rival.

Quid de la version 3.0 ?

Godot est passé en version 3.0 fin Janvier 2018. Cette version 3 constitue une petite révolution. En effet, le support du langage C# est aujourd'hui assuré et Godot devient encore plus accessible aux développeurs Unity3D ayant envie de basculer sur ce moteur. Les nouveautés ne s'arrêtent évidemment pas là : Visual Scripting, améliorations multiples au niveau du rendu, support de WebAssembly, nouveau moteur de son et tant d'autres encore. Bref, la version 3.0 dépote ! Voyons comment on l'installe !

 

Installation

À l'heure actuelle, Godot 3.0 est disponible en deux versions. La version Classique et la version Mono, destinée à programmer en C#. C'est cette dernière qui va nous intéresser.

Installation de Mono

Il est nécessaire d'installer Mono pour pouvoir compiler et exécuter C#. Actuellement, seule la version 5.4 de Mono est supportée.

Sous MacOSX

Téléchargez et installez le pkg présent ici.

Sous Windows

Téléchargez et exécutez le .msi présent ici.

Sous Linux

Actuellement, le fait que la seule version compatible soit la 5.12 rend l'installation pour le moins compliquée sous Linux. La solution la plus "simple" est de compiler Godot Mono à partir des sources. Cela vous dispense de l'étape consistant à installer Mono mais risque de prendre un certain temps. Pour tous les détails, rendez-vous ici.

Installation de MSBuild

Pour compiler vos projets C# avec Godot, vous aurez besoin de MSBuild. Le processus d'installation diffère selon la plateforme.

Sur Windows

Normalement, l'installation des outils de compilation de Visual Studio suffisent. Néanmoins, j'ai personnellement rencontré des problèmes si je n'installais pas au moins la version communautaire de Visual Studio. Je vous conseille de faire de même si vous rencontrez des problèmes lors du lancement de votre projet Godot.

Sur Linux

Si vous êtes sur LinuxX, il peut être nécessaire d'installer MSBuild. Voici la commande à utiliser sur Debian et ses dérivés :

sudo apt install ms-build*

Sur MacOSX

L'installation de MSBuid n'est pas nécessaire mais il est possible que vous ayez besoin de rajouter à votre PATH. Ouvrez un terminal et tapez :

export PATH=$PATH:/Library/Frameworks/Mono.framework/Versions/Current/bin

Devrait faire l'affaire.

 

Installation de Visual Studio Code

Pour profiter d'un expérience optimale de développement en C# sur Godot Engine 3.0, il est aujourd'hui préférable de passer par un éditeur de code externe. Visual Studio Code est un bon choix. Il est disponible à cette adresse : https://code.visualstudio.com/

Une fois que c'est fait, je vous conseille (très fort) d'installer l'extension C#. Pour ce faire, nous allons démarrer Visual Studio Code et nous rendre dans le menu Extension

. Entrez "C#" dans le champ de recherche et sélectionner l'extension C#.

 

Installation de Godot Engine 3.0

Installation directe

Godot Engine est disponible ici : https://godotengine.org/download

Choisissez la version qui correspond à votre système d'exploitation. Dans ce tutoriel, on utilise la version Mono afin de pouvoir programmer en C#.

Le logiciel se présente sous la forme d'une simple dossier contenant un exécutable qu'il suffit de lancer pour démarrer le développement.

 

Compilation à partir des sources

Certains ne souhaitent pas (ou ne peuvent pas) installer Mono 5.4 globalement sur leur machine. Dans ce cas, une solution est de compiler Godot à partir des sources. Cela peut faire peur mais c'est une façon très propre de s'y prendre. Je vous conseille en revanche de vous armer de patience (ou de café, ou des deux!)

Les détails concernant la compilation à partir des sources se trouve ici. Choisissez la documentation correspondant à votre système. Pour ajouter mono à la compilation, suivez également ces instructions.

 

Démarrer un projet

Lancer l'exécutable de Godot présent à l'intérieur du dossier. Vous devriez tomber sur un page d'accueil de ce genre.

Cliquez sur nouveau projet. Une popup s'affiche. Entrez comme nom de projet "Test Godot 3" et cliquez sur Créer dossier. Une fois que c'est fait, cliquez sur Create and Edit pour démarrer le développement !

Une fois que c'est fait, l'interface de Godot s'affiche.

Au centre, vous avez la scène que vous êtes en train de créer. Sur votre gauche, vous avez accès à quelques assets présents par défaut. À droite, apparaissent la hiérarchie et l'inspecteur de nœuds. Nous reviendrons dans un autre chapitre sur cette interface. Ce n'est pas le sujet ici. Nous vérifions simplement que tout fonctionne !

Changer l'éditeur de code

Pour utiliser Visual Studio Code comme éditeur par défaut : cliquez sur le menu Editeur puis Paramètres de l'éditeur. À gauche, dans l'onglet général, si vous scrollez en bas des rubriques de la sidebar, vous tombez sur la rubrique Mono. Cliquez sur Editor pour changer l'éditeur par défaut :

Choisissez Visual Studio Code si, comme moi, vous souhaitez utiliser Visual Studio Code et cliquez sur Fermer.

Tester

Ajouter des noeuds à la scène

Vérifions que tout fonctionne bien. Passez en vue 2D en cliquant sur le bouton 2D en haut au milieu.

Une fois que c'est fait, nous allons ajouter un bouton (Button) et une étiquette (label) à notre projet. Ce bouton et cette étiquette seront ajoutés au sein d'un panneau (Panel). Cliquons sur l'arbre de la scène à droite, puis sur le +.

Une popup permettant de choisir l'élément à ajouter s'affiche. Saisissez dans le champs de recherche le mot Panel et sélectionner l'élément Panel.

Répétez l'opération avec un élément Button et un élément Label. Attention, le bouton et le label doivent de préférence être situés au même niveau de la hiérarchie, et non inclus l'un dans l'autre :

Vos éléments doivent apparaître dans la scène à la position 0,0

Cliquez sur ces éléments et étendez-les grâce aux "points chauds" de façon à obtenir la figure suivante.

Pour ajouter du texte dans notre bouton ou dans notre label, il suffit de sélectionner l'élément et d'éditer la propriété Text dans l'inspecteur en bas à droite :

Mettez "bonjour", par exemple, comme texte pour le label et "cliquez-moi" comme texte pour le bouton.

Attacher un script

Nous allons maintenant attacher un script à notre panneau en faisant un clic droit dessus dans l'arbre du projet à gauche et en cliquant sur Attacher un script :

Une popup s'affiche : Sélectionnez C# comme langage et indiquez res://PanelBehaviour.cs comme Chemin. Puis, cliquez sur Créer. Visual Studio Code devrait démarrer et afficher le code de notre nouveau script.

using Godot;
using System;

public class PanelBehaviour : Panel
{
    // Member variables here, example:
    // private int a = 2;
    // private string b = "textvar";

    public override void _Ready()
    {
        // Called every time the node is added to the scene.
        // Initialization here
        
    }

//    public override void _Process(float delta)
//    {
//        // Called every frame. Delta is time since last frame.
//        // Update game logic here.
//        
//    }
}

Il y a beaucoup de code commenté, présent à titre d'exemple. Faisons le ménage :

using Godot;
using System;

public class PanelBehaviour : Panel
{

    public override void _Ready()
    {
        
    }
}

Ajoutons une variable privée à notre classe, appelée "compteur". Ce compteur sera l'entier qui contiendra le nombre de fois ou l'on a cliqué sur le bouton.

private int compteur;

Dans la méthode _Ready, initialisons cet entier à 0 :

public override void _Ready()
{
    this.compteur = 0;
}

Nous allons ajouter la méthode IncrementerCompteur permettant d'augmenter la valeur du compteur de 1 et de mettre à jour cette valeur dans notre Label :

public void IncrementerCompteur()
{
    this.compteur++;
    Label label = (Label)GetNode("Label");
    label.Text = this.compteur.ToString();
}

Il ne nous manque plus qu'à demander à Godot de déclencher cette méthode lorsque le bouton est cliqué ! Faisons-le dans la méthode _Ready.

public override void _Ready()
{
    this.compteur = 0;
    GetNode("Button").Connect("pressed", this, nameof(IncrementerCompteur));
}

Notre projet est prêt. Lancez-le. Au premier démarrage, Godot vous demandera d'enregistrer votre scène. Faites !

Une fois que votre scène est lancée, le compteur devrait se mettre à jour en temps réel.

Si tel est le cas, bravo, votre installation s'est bien passée !