TowerDefence/Dokumentation
6
0
Fork 0
Code Wiki Activity
Page: Guides/Development Setup
Pages
Administration/Config Architektur Client/Config Companion/Config DoD DoR FAQ Guides/Development Setup Home Rollenverteilung Server/Config Server Protokoll Timeline
6 Guides/Development Setup
Snoweuph edited this page 2025-02-02 21:28:46 +00:00
Table of Contents

Development Setup

Client

Um am Client zu arbeiten werden zwei Dinge benötigt: Redot Engine und GDToolkit. Mit diesem Setup wird der Code automatisch beim Speichern formatiert, solange direkt in Redot gearbeitet wird.

Linux

Redot Engine

  1. Binary von https://www.redotengine.org/download/linux herunterladen
  2. Entpacken und die ausführbare Datei nach ~/.local/bin/redot tun
  3. (Optional) Icon herunterladen von hier und nach ~/.icons/redot.svg tun
  4. ~/.local/share/applications/redot.desktop anlegen mit folgendem Content (username muss ausgetauscht werden): 
    [Desktop Entry]
Name=Redot Engine
GenericName=forked game engine
Comment=Multi-platform 2D and 3D game engine with a feature-rich editor
Exec=env PATH="$HOME/.local/bin:$PATH" redot %f
Icon=/home/username/.icons/redot.svg
Terminal=false
PrefersNonDefaultGPU=true
Type=Application
MimeType=application/x-godot-project;
Categories=Development;IDE;
StartupWMClass=Godot

GDToolkit

  1. pip install "gdtoolkit==4.*"

MacOS

Redot Engine

  1. App Bundle herunterladen
  2. App Bundle nach Applikationen verschieben

GDToolkit

  1. pip install "gdtoolkit==4.*"

Windows

Caution

you can try it, but I highly suggest you don't

Server

Der Server ist eine Springbootapplikation. Es wird Gradle und Java benötigt. Beides wird direkt von JetBrains IntelliJ geliefert. Das Projekt liefert außerdem direkte Konfiguration für IntelliJ.

Es ist zusätzlich empfohlen, vor dem Committen alle Checks lokal auszuführen, dies kann entweder für jeden Check manuell mit Gradle gemacht werden, oder in IntelliJ direkt mit der Check Run-Konfiguration.

Administration / Companion App

Die Administration und Companion App sind Angular Applikationen, dementsprechend ist Angular CLI benötigt. Zusätzlich wird auf Volta für Node Management gesetzt, so wie auf Just für einfache Scripte gesetzt.

  1. Installiere die drei oben genannten Tools
  2. führe ein npm i aus, um alle node dependencies zu installieren
  3. führe ein just generate aus, um den API Client zu generieren
  4. führe ein ng serve aus, um das Projekt auszuführen

Es ist außerdem empfohlen, vor dem Committen das lokale Linting auszuführen, mit just lint.