diff --git a/.readme/0_DownlaodIDEA.png b/.readme/0_DownlaodIDEA.png new file mode 100644 index 0000000..296ca07 Binary files /dev/null and b/.readme/0_DownlaodIDEA.png differ diff --git a/.readme/1_IstallIDEA.png b/.readme/1_IstallIDEA.png new file mode 100644 index 0000000..4b0b74b Binary files /dev/null and b/.readme/1_IstallIDEA.png differ diff --git a/.readme/2_InstallGIT.png b/.readme/2_InstallGIT.png new file mode 100644 index 0000000..b19d91e Binary files /dev/null and b/.readme/2_InstallGIT.png differ diff --git a/.readme/3_ConfigureJDK.png b/.readme/3_ConfigureJDK.png new file mode 100644 index 0000000..858e6d5 Binary files /dev/null and b/.readme/3_ConfigureJDK.png differ diff --git a/.readme/4_RunPlanetSudo.png b/.readme/4_RunPlanetSudo.png new file mode 100644 index 0000000..3549448 Binary files /dev/null and b/.readme/4_RunPlanetSudo.png differ diff --git a/.readme/5_Refactor.png b/.readme/5_Refactor.png new file mode 100644 index 0000000..fc6b5a1 Binary files /dev/null and b/.readme/5_Refactor.png differ diff --git a/README.md b/README.md index 254d8ec..8fcfc40 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,43 @@ ### Intellij installieren -- IntelliJ Community Edition herunterladen und installieren sofern nicht schon vorhanden. - - https://www.jetbrains.com/idea/download/ - -### Tools installieren +- IntelliJ **Community Edition** (nicht die Ultimate Edition!) [herunterladen](https://www.jetbrains.com/idea/download/) und installieren.

+![Downloadseite der Community Edition](.readme/0_DownlaodIDEA.png)

+![Installationsübersicht der IntelliJ IDEA](.readme/1_IstallIDEA.png)

-- JDK 17 (Java Development Kit 17) via IntelliJ installieren. -- GIT via IntelliJ installieren. +### Git installieren + +- In IntelliJ auf `Get from VSC` klicken, dann auf `Repository URL`. +- Version control auf `Git` einstellen. +- Sollte die Fehlermeldung `Git is not installed` auftauchen auf `Download and Install` klicken.

+![Übersicht des Get from Version Control Fensters](.readme/2_InstallGIT.png)

### Planet Sudo installieren -- TODO JONAS -- Jetzt kann PlanetSudo gestartet werden. (Hierzu auf den grünen Playbutton drücken) -- Um eine bessere Unterstützung bei der KI-Entwickelung zu erhalten, in der "Project" Ansicht einen rechten Mausklick auf den "ai" Wurzelordner ausführen und anschließen auf "Maven->Download Source and Documentation" klicken. +- In IntelliJ im selben Fenster die URL `https://github.com/openbase/planetsudo` einfügen und auf `Clone` klicken. +- Sollte die Fehlermeldung `JDK "17" is missing` auftreten auf `Configure...` --> `Download JDK` gehen und dann `Eclipse Temurin` auswählen und installieren.

+![Das Download JDK Fenster](.readme/3_ConfigureJDK.png)

+- Die Datei `src/main/kotlin/org.openbase.planetsudo/main/PlanetSudo.kt` öffnen (Doppelklick). +- Jetzt kann PlanetSudo gestartet werden. (Hierzu auf den grünen Playbutton drücken)

+![Wie man Planet Sudo Startet](.readme/4_RunPlanetSudo.png)

## Anlegen einer neuen KI -- Im PlanetSudoAI Projektansicht zur Klasse "DefaultStrategy.kt" navigieren (src->main->kotlin->org->openbase->planetsudo->game->strategy) und hier die "DefaultStrategy.kt" mit einem Rechtsklick auf die Klasse (Refactor->Rename) umbenennen. +- Im PlanetSudoAI Projektansicht zur Klasse "DefaultStrategy.kt" navigieren (`src/main/kotlin/org.openbase.planetsudo/game.strategy`) und hier die `DefaultStrategy.kt` mit einem Rechtsklick auf die Klasse (`Refactor` --> `Rename`) umbenennen.

+![Wie man eine Klasse umbenennt](.readme/5_Refactor.png)

- Die neue Strategieklasse kann nun erweitert werden. -- Informationen über mögliche Funktionalitäten könnt ihr über die Methoden Dokumentation (JavaDoc) herausfinden. - - z. B. ihr schreibt "agent." und drückt dann (Strg + Leertaste). +- Informationen über mögliche Funktionalitäten könnt ihr über die Methoden Dokumentation herausfinden. + - z. B. ihr schreibt `agent.` und drückt dann (Strg + Leertaste). ## Anlegen eines neuen Teams - Sofern ihr zuvor eine neue Strategieklasse angelegt habt, bitte zunächst PlanetSudo beenden und anschließen neu starten. -- Anschließend in PlanetSudo unter Einstellungen auf "Team erstellen" klicken. -- Wichtig ist hierbei, dass eine gültige Strategie angegeben wird. Hier erfolgt die Eingabe des Namens der zuvor erstellten Strategieklasse. Der Dateitype (".kt") wird hierbei nicht benötigt. +- Anschließend in PlanetSudo unter `Einstellungen` auf `Team erstellen` klicken. +- Wichtig ist hierbei, dass eine gültige Strategie angegeben wird. Hier erfolgt die Eingabe des Namens der zuvor erstellten Strategieklasse. Der Dateityp (".kt") wird hierbei nicht benötigt. ## Mit dem Server synchronisieren -- Zunächst muss das eigene Team definiert werden. Hierzu in dem DropDown Menü (Mein Team) ein Team auswählen und anschließend bestätigen. +- Zunächst muss das eigene Team definiert werden. Hierzu in dem DropDown Menü `Dein Team` ein Team auswählen und anschließend bestätigen (`Setzen`). - Nun kann über den Synchronisations-Button die Synchronisation erfolgen, sofern der Server erreichbar ist. - Ist das Statusfeld Blau, ist der Transfer erfolgreich gewesen. @@ -41,8 +48,8 @@ - Viel Spaß beim KI Entwickeln und Spielen :) - Sollten euch gravierende Fehler auffallen, anderweitige Probleme auftreten oder ihr eine coole Erweiterungsidee habt: - - Erstellt ein Issue auf Github (https://github.com/openbase/planetsudo/issues/new) - - Oder Kontaktiert uns per mail: support@openbase.org + - Erstellt ein Issue auf [Github](https://github.com/openbase/planetsudo/issues/new) + - Oder kontaktiert uns per [Mail](mailto:support@openbase.org) Copyright (C) 2009 - 2024 openbase.org