Skip to content

Commit

Permalink
Merge pull request #5 from openbase/readmeUpdate
Browse files Browse the repository at this point in the history
Readme update
  • Loading branch information
DivineThreepwood authored Mar 8, 2024
2 parents e191cdf + 7ae344b commit 2d542d0
Show file tree
Hide file tree
Showing 16 changed files with 28 additions and 14 deletions.
Binary file added .readme/0_NotUltimate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/10_CompletionSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/11_DocumentationPopup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/12_TeamErstellen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/13_TeamBennenung.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed .readme/4_RunPlanetSudo.png
Binary file not shown.
Binary file added .readme/5_RunPlanetSudo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/6_Configurations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/7_ServerImplement.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .readme/8_DownloadSources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,58 @@

### Intellij installieren

- IntelliJ **Community Edition** (nicht die Ultimate Edition!) [herunterladen](https://www.jetbrains.com/idea/download/) und installieren.</br></br>
![Downloadseite der Community Edition](.readme/0_DownlaodIDEA.png)</br></br>
![Installationsübersicht der IntelliJ IDEA](.readme/1_IstallIDEA.png)</br></br>
- IntelliJ ***Community Edition*** (nicht die Ultimate Edition!) [herunterladen](https://www.jetbrains.com/idea/download/) und installieren.</br></br>
![Downloadseite der Ultimate Edition](.readme/0_NotUltimate.png)</br></br>
![Downloadseite der Community Edition](.readme/1_DownlaodIDEA.png)</br></br>
![Installationsübersicht der IntelliJ IDEA](.readme/2_IstallIDEA.png)</br></br>

### 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.</br></br>
![Übersicht des Get from Version Control Fensters](.readme/2_InstallGIT.png)</br></br>
![Übersicht des Get from Version Control Fensters](.readme/3_InstallGIT.png)</br></br>

### 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.</br></br>
![Das Download JDK Fenster](.readme/3_ConfigureJDK.png)</br></br>
![Das Download JDK Fenster](.readme/4_ConfigureJDK.png)</br></br>

- 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)</br></br>
![Wie man Planet Sudo Startet](.readme/4_RunPlanetSudo.png)</br></br>
- Jetzt kann PlanetSudo gestartet werden. Dazu einen Rechtsklick auf `Planet Sudo` und dann auf `Run 'Planet Sudo'` </br></br>
![Wie man Planet Sudo Startet](.readme/5_RunPlanetSudo.png)</br></br>

- 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.</br></br>
![Öffnen der Configurations](.readme/6_Configurations.png)</br></br>
![Einstellen des Servers](.readme/7_ServerImplement.png)</br></br>

- Als Nächstes muss die Dokumentation heruntergeladen werden. Dazu in IntelliJ rechts an der Seite das Gradle-Menü öffnen und auf `Download Sources` klicken.</br></br>
![Herunterladen der Dokumentation](.readme/8_DownloadSources.png)</br></br>

## 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.</br></br>
![Wie man eine Klasse umbenennt](.readme/5_Refactor.png)</br></br>
- 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.</br></br>
![Wie man eine Klasse umbenennt](.readme/9_Refactor.png)</br></br>
- 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`.</br></br>
![Öffnen der Code Completion Settings](.readme/10_CompletionSettings.png)</br></br>
- Dort aktiviert man `Show the documentation popup in X ms` und stellt die Zeit nach Belieben ein (z.B. 10 ms).</br></br>
![Ä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.</br></br>
![Wie man ein Team erstellt](.readme/12_TeamErstellen.png)</br></br>
![Wie man sein Team benennt](.readme/13_TeamBennenung.png)</br></br>

## 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
Expand All @@ -52,4 +66,4 @@
- Oder kontaktiert uns per [Mail](mailto:[email protected])


Copyright (C) 2009 - 2024 openbase.org
Copyright (C) 2009 - 2024 [openbase.org](http://www.openbase.org)

0 comments on commit 2d542d0

Please sign in to comment.