Skip to content

Projekt einrichten

Jump to bottom
damios edited this page Oct 28, 2018 · 13 revisions

Dieser Eintrag beschreibt, wie das Projekt von Github geklont und in Eclipse eingerichtet werden kann.


Einen SSH-Key einrichten

Das Repository auf Github wird über SSH geklont. Dazu muss im eigenen Github-Account ein SSH-Key hinterlegt werden, der es dem lokalen Computer erlaubt auf Github zu agieren. Sofern dies bereits für vorige Projekte erledigt wurde, kann dieser Schritt übersprungen werden.

Den SSH-Key in Eclipse generieren

  1. Unter Window > Preferences > General > Network Connections > SSH2 den Tab Key Management auswählen
  2. Über die Schaltfläche Generate RSA Key... kann dann ein neuer RSA-Schlüssel generiert werden
  3. In die Passphrase und Confirm passphrase-Felder ein Passwort für den Schlüssel eingeben. Dieses Passwort muss in Zukunft immer eingegeben werden, wenn mit dem origin-Repository (also dem auf Github) interagiert werden soll
  4. Den öffentlichen Schlüssel aus dem großen Textfeld kopieren; dieser wird gleich noch benötigt
  5. Den privaten Schlüssel über die Schaltfläche Save Private Key... lokal speichern

Den SSH-Key im Github-Account hinterlegen

  1. Die Einstellungen des eigenen Github-Accounts aufrufen (github.com/settings/profile)
  2. Den Menupunkt SSH and GPG keys auswählen
  3. Rechts oben auf den New SSH Key-Button klicken
  4. Im nun erscheinenden Formular einen aussagekräftigen Namen für den Key (bspw. "PC 123 – Eclipse") vergeben und den eben kopierten öffentlichen Schlüssel in das untere Feld einfügen
  5. Den Schlüssel mit einem Klick auf Add SSH key speichern

Das Projekt in Eclipse importieren

Ein lokales Repository einrichten

  1. Über Window > Show View > Other... > Git > Git Repositories die Git Repositories-Ansicht anzeigen lassen
  2. In diesem Repositories-Fenster auf das Clone a git repository...-Icon (am grünen Pfeil erkennbar) drücken
  3. Folgenden String in das URI-Feld kopieren: [email protected]:eskalon/ProjektGG.git. Dadurch wird das ProjektGG-Repo über SSH geklont
  4. In der Branch Selection, die über einen Klick auf Next erscheint, einen Haken vor master setzen. Dadurch wird der master-Branch des Repositories geklont. Auf Next klicken.
  5. Im nun erscheinenden Local Destination-Dialog ein lokales Verzeichnis für den Git-Klon auswählen. Unten im Configuration-Teil als Remote name origin eingeben. Das ist in Zukunft der Name für das Ursprungs-Repository auf Github. Auf Finish klicken.

Das Projekt importieren

  1. Nun unter File > Import... > Gradle > Existing Gradle Project auswählen. Gradle ist das Build Tool, über das ProjektGG seine Abhängigkeiten handhabt und auch gepackt wird.
  2. Sofern die Willkommens-Seite der Gradle-Integration erscheint, diese mit einem Klick auf Next überspringen
  3. Als Project root direcotry den Ordner auswählen, in den vorhin das Github-Repo geclont wurde. Auf Next klicken.
  4. Die Einstellungen im Options-Dialog können unverändert belassen werden. Sie bestimmen leidglich welche Gradle-Installation verwendet werden soll. Auf Next klicken.
  5. Warten, bis die Projekt-Struktur erkannt wurde. Falls der Gradle-Dämon verwendet wird, muss ggf. eine Firewall-Freigabe erfolgen. Anschließend auf Finish drücken. Nun sollten im Package-Explorer vier neue Projekte erschienen sein, das Root-Projekt für das Spiel, das Engine-Projekt, das Game-Projekt für den eigentlichen Spiel-Code und das Desktop-Projekt, welches den Desktop-Launcher, also die Klasse über die das Spiel auf Desktopgeräten gestartet wird, enthält.

Java-Laufzeitumgebung einrichten

ProjektGG benötigt eine installierte Java-Laufzeitumgebung von 9+. Falls Eclipse keine solche bekannt ist, muss diese zunächst eingerichtet werden, bevor das Projekt gestartet werden kann.

  1. Zuerst muss die entsprechende Laufzeitumgebung installiert werden. Heruntergeladen werden kann diese hier
  2. Unter Window > Preferences > Java > Installed JREs über Add... kann die JRE dann zu Eclipse hinzugefügt werden
  3. Dazu zunächst Standard VM auswählen und anschließend unter Java Home das Installationsverzeichnis der JRE angeben (bspw. "C:\Program Files\Java\jre-10.0.2"). Finish klicken.
  4. Abschließend auf den Apply and Close-Button rechts unten drücken

Github-Account in Eclipse einrichten

Damit die Commits auf Github dem richtigen Nutzer zugeordnet werden können, ist es notwendig, seine Commit-Email in Eclipse richtig einzustellen. Das geht unter Window > Preferences > Team > Git > Configuration. Über Add Entry... müssen dort die folgenden zwei Einträge ("GITHUB_USER_NAME" natürlich jeweils durch den eigenen Github-Nutzernamen ersetzt) hinzugefügt werden:

  • Key: "user.email"
    Value: "GITHUB_USER_NAME@users.noreply.github.com"
  • Key: "user.name"
    Value: "GIHTUB_USER_NAME"

Das Projekt starten

  1. Um das Projekt zu starten, muss zunächst das ProjektGG-desktop-Projekt mit einem Klick auf eben dieses im Package-Explorer ausgewählt werden. Dann kann die Anwendung mit einem Klick auf den Run-Button gestartet werden: Das Run-Icon in Eclipse
  2. Beim ersten Start fragt Elipse nach der richtigen Main-Klasse. Hier muss DesktopLauncher ausgewählt werden
  3. Ferner muss noch die Run Configuration angepasst werden. Dazu nach einem Rechtsklick auf das ProjektGG-desktop-Projekt Run As > Run Configurations... auswählen
  4. Anschließend muss im Arguments-Tab das richtige Working directory ausgewählt werden. Das klappt durch einen Klick auf Other > Workspace... > ProjektGG-game > assets

Anschließend sollte noch der Code Style des Projekts in der IDE eingerichtet werden!

Inhaltsverzeichnis

Clone this wiki locally