diff --git a/.readme/0_NotUltimate.png b/.readme/0_NotUltimate.png new file mode 100644 index 0000000..8ecbaa0 Binary files /dev/null and b/.readme/0_NotUltimate.png differ diff --git a/.readme/10_CompletionSettings.png b/.readme/10_CompletionSettings.png new file mode 100644 index 0000000..d8b7d2d Binary files /dev/null and b/.readme/10_CompletionSettings.png differ diff --git a/.readme/11_DocumentationPopup.png b/.readme/11_DocumentationPopup.png new file mode 100644 index 0000000..8d87e0e Binary files /dev/null and b/.readme/11_DocumentationPopup.png differ diff --git a/.readme/12_TeamErstellen.png b/.readme/12_TeamErstellen.png new file mode 100644 index 0000000..b4a9ee7 Binary files /dev/null and b/.readme/12_TeamErstellen.png differ diff --git a/.readme/13_TeamBennenung.png b/.readme/13_TeamBennenung.png new file mode 100644 index 0000000..f78a883 Binary files /dev/null and b/.readme/13_TeamBennenung.png differ diff --git a/.readme/0_DownlaodIDEA.png b/.readme/1_DownlaodIDEA.png similarity index 100% rename from .readme/0_DownlaodIDEA.png rename to .readme/1_DownlaodIDEA.png diff --git a/.readme/1_IstallIDEA.png b/.readme/2_IstallIDEA.png similarity index 100% rename from .readme/1_IstallIDEA.png rename to .readme/2_IstallIDEA.png diff --git a/.readme/2_InstallGIT.png b/.readme/3_InstallGIT.png similarity index 100% rename from .readme/2_InstallGIT.png rename to .readme/3_InstallGIT.png diff --git a/.readme/3_ConfigureJDK.png b/.readme/4_ConfigureJDK.png similarity index 100% rename from .readme/3_ConfigureJDK.png rename to .readme/4_ConfigureJDK.png diff --git a/.readme/4_RunPlanetSudo.png b/.readme/4_RunPlanetSudo.png deleted file mode 100644 index 3549448..0000000 Binary files a/.readme/4_RunPlanetSudo.png and /dev/null differ diff --git a/.readme/5_RunPlanetSudo.png b/.readme/5_RunPlanetSudo.png new file mode 100644 index 0000000..6a55066 Binary files /dev/null and b/.readme/5_RunPlanetSudo.png differ diff --git a/.readme/6_Configurations.png b/.readme/6_Configurations.png new file mode 100644 index 0000000..e8242b7 Binary files /dev/null and b/.readme/6_Configurations.png differ diff --git a/.readme/7_ServerImplement.png b/.readme/7_ServerImplement.png new file mode 100644 index 0000000..800656f Binary files /dev/null and b/.readme/7_ServerImplement.png differ diff --git a/.readme/8_DownloadSources.png b/.readme/8_DownloadSources.png new file mode 100644 index 0000000..27f09d8 Binary files /dev/null and b/.readme/8_DownloadSources.png differ diff --git a/.readme/5_Refactor.png b/.readme/9_Refactor.png similarity index 100% rename from .readme/5_Refactor.png rename to .readme/9_Refactor.png diff --git a/README.md b/README.md index 8fcfc40..e882be1 100644 --- a/README.md +++ b/README.md @@ -4,44 +4,58 @@ ### Intellij 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)

+- IntelliJ ***Community Edition*** (nicht die Ultimate Edition!) [herunterladen](https://www.jetbrains.com/idea/download/) und installieren.

+![Downloadseite der Ultimate Edition](.readme/0_NotUltimate.png)

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

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

### 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)

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

### Planet Sudo installieren - 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)

+![Das Download JDK Fenster](.readme/4_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)

+- Jetzt kann PlanetSudo gestartet werden. Dazu einen Rechtsklick auf `Planet Sudo` und dann auf `Run 'Planet Sudo'`

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

+ +- Wenn du dich mit einem PlanetSudo Server verbinden willst, kannst du diesen in IntelliJ wie folgt einstellen: Dazu oben rechts auf `PlanetSudo` klicken dort auf `Edit Configuration` und dann unter `Programm arguments: --server YOUR_SERVER_NAME` eingeben. Dann das ganze mit `Apply` bestätigen.

+ ![Öffnen der Configurations](.readme/6_Configurations.png)

+![Einstellen des Servers](.readme/7_ServerImplement.png)

+ +- Als Nächstes muss die Dokumentation heruntergeladen werden. Dazu in IntelliJ rechts an der Seite das Gradle-Menü öffnen und auf `Download Sources` klicken.

+![Herunterladen der Dokumentation](.readme/8_DownloadSources.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.

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

+- In IntelliJ 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/9_Refactor.png)

- Die neue Strategieklasse kann nun erweitert werden. - 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). +- Dazu in der Strategie `agent.` schreiben und dann Strg + Leertaste drücken. +- Nun werden die möglichen Funktionen aufgeführt. Um eine detaillierte Beschreibung über die Funktionen zu erhalten, geht auf die drei Punkte und dort auf `Code Completion Settings`.

+![Öffnen der Code Completion Settings](.readme/10_CompletionSettings.png)

+- Dort aktiviert man `Show the documentation popup in X ms` und stellt die Zeit nach Belieben ein (z.B. 10 ms).

+![Ändern der Einstellungen](.readme/11_DocumentationPopup.png) ## 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 Dateityp (".kt") wird hierbei nicht benötigt. +- 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.

+![Wie man ein Team erstellt](.readme/12_TeamErstellen.png)

+![Wie man sein Team benennt](.readme/13_TeamBennenung.png)

## Mit dem Server synchronisieren -- 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. +- In Planet Sudo kann über den Synchronisations-Button die Synchronisation erfolgen. - Ist das Statusfeld Blau, ist der Transfer erfolgreich gewesen. ## Sonstiges @@ -52,4 +66,4 @@ - Oder kontaktiert uns per [Mail](mailto:support@openbase.org) -Copyright (C) 2009 - 2024 openbase.org +Copyright (C) 2009 - 2024 [openbase.org](http://www.openbase.org)