DE:Kompilieren unter Windows

Quelltext herunterladen

Der Quelltext von OpenClonk wird über ein sogenanntes Versionskontrollsystem bereitgestellt. Dieses ermöglicht es Programmierern, vereinfacht ausgedrückt, ihre Arbeit zu koordinieren (siehe Git-Artikel für Details). Vorerst sind das einfach die Dateien die du herunterladen musst.

TortoiseGit installieren

Der entscheidende Unterschied zu einem einfachen Download ist, dass man ein spezielles Programm dafür benötigt. Wir benutzen dazu den TortoiseGit-Client. Öffne den Link und klicke auf „Download“.

Build windows tgit.png

Die Installation von TortoiseGit besteht, wie auf der Website beschrieben, aus den beiden Teilen TortoiseGit und msysGit. Außerdem heißt es dort, dass man mit der Installation von TortoiseGit beginnen soll. Lade es herunter indem du die zu deiner Windows-Installation passende Architektur auswählst:

Build windows tgit2.png

Starte dann die Installation. Die Standardeinstellungen sind dabei ausreichend.

OpenClonk-Teammitglieder: Wähle die entsprechende Option aus wenn du PuTTY zum Pushen von Commits verwenden willst. Das Gleiche gilt für die darauffolgende Installation von msysGit.

Build windows tgit4.png

Als nächstes benötigst du msysGit, da es für die eigentliche Arbeit zuständig ist. Öffne den Link „Full installer for official Git“ um zur Download-Seite zu gelangen:

Build windows tgit3.png

Die Installation wird diesmal noch verwirrendere Fragen stellen. Aber auch hier gilt: Die Standardoptionen sind ausreichend. Es ist jedoch empfehlenswert, einige GUI-Optionen zu deaktivieren, da TortoiseGit sie bereits anbietet:

Build windows tgit5.png

Nachdem die Installation abgeschlossen ist hat man eine funktionierende TortoiseGit-Installation.

Klonen

Wir werden jetzt den Quelltext herunterladen. Git nennt dies „Klonen“, da man eigentlich viel mehr als nur den Quelltext bekommt. Wenn du fertig bist, kannst du dir die Git Workflow-Seite ansehen um herauszufinden, wie man mit dem Klon arbeitet.

Suche nun einen Ort aus, an dem der Quelltext abgelegt werden soll. Öffne dann per Rechtsklick das Kontextmenü und wähle „Git Clone...“ aus dem TortoiseGit-Menü aus:

Build windows tgit6.png


Daraufhin erscheint ein Dialog zur Eingabe der Repository-URL und des Zielpfades. In unserem Fall ist die Quelle das OpenClonk-Repository. Die benötigte URL ist normalerweise „git://git.openclonk.org/openclonk.git“. Es sollte dann so aussehen:

OpenClonk Teammitglieder: Verwende stattdessen „ssh://git@git.openclonk.org/openclonk.git“ und aktiviere die Option zum automatischen Laden des PuTTY-Schlüssels.

Build windows tgit pub.png


Sobald man auf „OK“ klickt wird TortoiseGit eine Weile arbeiten. Nachdem man einer Schildkröte eine Weile beim Salto schlagen zugesehen hat, sollte das Klonen abgeschlossen sein. Glückwunsch, du hast nun den aktuellsten Stand der OpenClonk-Entwicklung auf deiner Festplatte!

Build windows tgit finish.png

Das ist ziemlich viel Zeug und wahrscheinlich wirst du nicht viel davon verstehen. Hier ist eine kurze Orientierungshilfe für die wichtigsten Teile:

  • „docs“ - Der Quelltext der Dokumentation
  • „planet“ - Die Spielressourcen - Scripts, Grafiken und alles zur Erklärung wie daraus ein Spiel wird
  • „src“ - Der gesamte Source Code der Spiel-Engine. Sehr viel C++.

Kompilieren

So weit, so gut. Unser Ziel ist aber ein laufendes Spiel zu erhalten. Dazu benötigen wir ein Programm das aus all diesen C++-Dateien eine ausführbare Datei macht. Leider ist Programmieren kompliziert und daher ist selbst das Installieren der Tools und der Umgebung etwas schwierig. Aber das wird uns nicht aufhalten.

Microsoft Visual Studio installieren

Man kann über Microsoft sagen was man will, aber sie machen schöne Entwicklungsumgebungen. Und sie verteilen viele davon sogar gratis. Wir werden Visual Studio C++ 2012 verwenden. Öffne den Link, klicke auf die 2012 Express Edition für Windows Desktop und dann lade den Web Installer herunter:

Vergewissere dich, dass du die „Windows Desktop“-Variante auswählst.

Starte ihn, akzeptiere die Lizenzbedingungen, klicke auf den großen „Installieren“-Link und bestätige die UAC-Abfrage.

Dann mach dir einen Kaffee, denn die Installation wird wahrscheinlich eine Weile dauern. Bestätige, falls du gefragt wirst, ob der Computer neu gestartet werden soll; die Installation geht dann nach der Anmeldung weiter.

Abhängigkeiten installieren

Wie auch andere große Programme kommt Clonk nicht alleine aus: Einige Dinge (wie das Öffnen von PNG-Bildern) wurden bereits von anderen Programmierern viel besser als wir es jemals könnten programmiert. Daher benötigen wir so genannte „Bibliotheken“ bevor Clonk kompiliert werden kann.

Man könnte viel Aufwand betreiben um diese Bibliotheken alle selbst zu suchen, downloaden und zu kompilieren, aber das würde einiges an Zeit kosten. Lade stattdessen eines der Pakete herunter die wir der Einfachheit halber anbieten. Wenn du Clonk als 32 Bit-Programm kompilieren willst oder nicht weißt was das ist, verwende das x86-Paket; für ein 64 Bit-Programm verwende das amd64-Paket. Entpacke dann den Inhalt in das Verzeichnis in dem auch die anderen Dateien liegen (achte darauf den „deps“-Ordner beizubehalten).

CMake installieren

Bevor das alles zum Einsatz kommt, muss dem Compiler noch gesagt werden, wie die Quelltexte und Bibliotheken zusammen kompiliert werden.

Dazu benötigt Visual C++ eine Projektdatei. Allerdings gibt es noch keine - man muss ein weiteres Programm nutzen um sie generieren zu lassen. Das scheint verwirrend - der Sinn dahinter ist aber dass es viele Entwicklungsumgebungen neben Visual Studio gibt und all diese Projektdateien nebeneinander zu haben würde auf lange Sicht zu Problemen führen.

Was wir brauchen ist CMake. Öffne den Link und lade den Installer herunter:

Build windows cmake1.png


Du weißt was zu tun ist.

Build windows cmake2.png


Starte die CMake-GUI aus dem Startmenü sobald die Installation abgeschlossen ist. Trage den Pfad in den du das Repository geklont hast in das Source Code-Pfad-Feld ein.

Build windows cmake3.png


Klicke nun auf den „Configure“-Button unten links. Du wirst gefragt, welcher Compiler verwendet werden soll. Wähle den Compiler den du verwenden willst; entweder „Visual Studio 11“ wenn du das 32 Bit-Bibliotheken-Paket heruntergeladen hast oder „Visual Studio 11 Win64“ wenn du das 64 Bit-Paket hast.

Build windows cmake4.png

Solltest du Fehlermeldungen (in rot) erhalten, fehlen wahrscheinlich einige Abhängigkeiten. Sei unbesorgt falls CMake sich über fehlende Pfade beschwert; dies sollte nichts ausmachen.

Klicke zum Schluss auf den „Generate“-Button.

Dein erster Build

Wir haben nun alles was benötigt wird um OpenClonk das erste Mal zu starten. Öffne das Quelltext-Verzeichnis und klicke doppelt auf die Datei „openclonk.sln“ die nun angezeigt werden sollte.

Build windows build1.png


Visual C++ sollte sich öffnen und ähnlich wie hier aussehen:

Build windows build2.png


Wir wollen nur die Engine kompilieren. Wähle daher „openclonk“ aus der Liste aus, klicke mit rechts darauf und wähle „Als Startprojekt festlegen“ aus.

Build windows build3.png

Drücke nun F5 (oder klicke auf den „Lokaler Windows-Debugger“-Button in der Toolbar). Visual Studio erkennt, dass du noch keine aktuelle kompilierte Version von OpenClonk hast. Bestätige dass eine neue kompiliert werden soll. Falls gewünscht, wähle vorher noch aus, dass immer automatisch eine neue Version kompiliert werden soll, indem du die Checkbox auswählst.

Build windows outofdate.png

Wenn alles gut geht siehst du nach ein paar Minuten das OpenClonk-Hauptmenü.

Openclonk first start.jpg

Falls du dich wunderst weshalb OpenClonk plötzlich in einer Art Pseudo-Fenstermodus startet: Das liegt daran dass du einen „Debug Build“ kompiliert hast (siehst du das „dbg“ hinter der Version?). Dieser Build ist etwas langsamer, aber ermöglicht es dir, eine bessere Sicht auf die Funktionsweise der Engine zu erlangen während sie läuft. Vielleicht wird es darüber demnächst einen weiteren Artikel geben.