Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

CLion

CLion ist eine kommerzielle JetBrains-IDE für C++.

Projekt importieren

CLion kann die Kompilierungsdatenbankdatei eines Projekts importieren, die üblicherweise compile_commands.json heißt. Um die Kompilierungsdatenbankdatei zu erzeugen, öffnen Sie das Terminal, wechseln Sie in das Godot-Stammverzeichnis und führen Sie aus:

scons compiledb=yes

Öffnen Sie dann das Godot-Stammverzeichnis mit CLion. CLion importiert die Kompilierungsdatenbank, indiziert die Codebasis und bietet Autocompletion und andere fortschrittliche Code-Navigations- und Refactoring-Funktionen.

Kompilieren und Debuggen des Projekts

CLion unterstützt das Kompilieren und Debuggen von Godot über SCons nicht von Haus aus. Dies kann durch die Erstellung eines benutzerdefinierten Build-Targets und einer Run-Konfiguration in CLion erreicht werden. Bevor Sie ein benutzerdefiniertes Build-Target erstellen, müssen Sie Godot einmal auf der Kommandozeile kompilieren, um die ausführbare Godot-Datei zu erzeugen. Öffnen Sie das Terminal, wechseln Sie in das Godot-Stammverzeichnis und führen Sie aus:

scons dev_build=yes

So fügen Sie ein benutzerdefiniertes Build-Target hinzu, das SCons zur Kompilierung aufruft:

  • Öffnen Sie CLion und navigieren Sie zu Preferences > Build, Execution, Deployment > Custom Build Targets

../../../_images/clion-preferences.png
  • Klicken Sie auf Add target und geben Sie dem Ziel einen Namen, z.B. Godot debug.

../../../_images/clion-target.png
  • Klicken Sie auf ... neben dem Auswahlfeld Build: und dann auf den Button + im Dialogfeld External Tools, um ein neues externes Tool hinzuzufügen.

../../../_images/clion-external-tools.png
  • Geben Sie dem Tool einen Namen, z.B. Build Godot debug, setzen Sie Program auf scons, setzen Sie Arguments auf die gewünschten Kompilierungseinstellungen (siehe Godot kompilieren), und setzen Sie das Working directory auf $ProjectFileDir$, was dem Godot-Stammverzeichnis entspricht. Klicken Sie auf OK, um das Tool zu erstellen.

    Bemerkung

    CLion expandiert keine Shell-Befehle wie scons -j$(nproc). Verwenden Sie stattdessen konkrete Werte, z.B. scons -j8.

../../../_images/clion-create-build-tool.webp
  • Zurück im External Tools-Dialog, klicken Sie erneut auf +, um ein zweites externes Tool für die Bereinigung des Godot-Builds über SCons hinzuzufügen. Geben Sie dem Tool einen Namen, z.B. Clean Godot debug, setzen Sie Program auf scons, setzen Sie Arguments auf -c (was den Build bereinigt), und setzen Sie das Working directory auf $ProjectFileDir$. Klicken Sie OK, um das Tool zu erstellen.

../../../_images/clion-create-clean-tool.png
  • Schließen Sie das Dialogfeld External Tools. Im Dialog Custom Build Target für das benutzerdefinierte Godot-Debug-Build-Target, wählen Sie das Build Godot debug-Tool aus dem Build-Auswahlfeld, und wählen Sie das Clean Godot Debug-Tool aus dem Clean-Auswahlfeld. Klicken Sie auf OK, um das benutzerdefinierte Build-Target zu erstellen.

../../../_images/clion-select-tools.png
  • Klicken Sie im IDE-Hauptfenster auf Add Configuration.

../../../_images/clion-add-configuration.png
  • Klicken Sie im Dialogfeld Run/Debug Configuration auf Add new..., und wählen Sie dann Custom Build Application, um eine neue benutzerdefinierte Run/Debug-Konfiguration zu erstellen.

../../../_images/clion-add-custom-build-application.png
  • Geben Sie der Run/Debug-Konfiguration einen Namen, z.B. Godot debug, wählen Sie das benutzerdefinierte Build-Target Godot debug als Target. Wählen Sie die ausführbare Godot-Datei im bin/-Ordner als Executable, und setzen Sie Program arguments auf --editor --path path-to-your-project/, wobei path-to-your-project/ ein Pfad sein sollte, der auf ein existierendes Godot-Projekt zeigt. Wenn Sie das Argument --path weglassen, können Sie nur das Godot-Projektmanager-Fenster debuggen. Klicken Sie auf OK, um die Run/Debug-Konfiguration zu erstellen.

../../../_images/clion-run-configuration.png

Sie können jetzt den Godot-Editor über die Run-Konfiguration bauen, ausführen, debuggen, profilen und mit Valgrind prüfen.

../../../_images/clion-build-run.png

Wenn eine Szene abgespielt wird, erzeugt der Godot-Editor einen separaten Prozess. Sie können diesen Prozess in CLion debuggen, indem Sie Run > Attach to process... aufrufen, godot eingeben und den Godot-Prozess mit der höchsten pid (Prozess-ID) auswählen, was normalerweise das laufende Projekt ist.