Arbeitsumgebung einrichten: Unterschied zwischen den Versionen

Aus Das Sopra Wiki
Dietsch (Diskussion | Beiträge)
Langenfeld (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
 
(60 dazwischenliegende Versionen von 7 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{TOCRight}}
{{TOCRight}}
Die Arbeitsumgebung beinhaltet alle Produkte die im Sopra für die Entwicklung benötigt werden. In diesem Artikel wird beschrieben wie Sie Ihre Arbeitsumgebung einrichten und testen. Sie benötigen mindestens eine der hier vorgestellten Alternativen.
Die Arbeitsumgebung beinhaltet alle Produkte die im Sopra für die Entwicklung benötigt werden. In diesem Artikel wird beschrieben wie Sie Ihre Arbeitsumgebung einrichten und testen.


== Poolrechner ==
== Windows / Linux ==
Im Pool ist Visual Studio 2019 derzeit nicht installiert. Jedoch kann stattdessen Visual Studio 2017 verwendet werden. Für die Verwendung mit MonoGame müssen folgende Schritte durchgeführt werden:
=== .NET===
* Windows booten: bei Start des PCs im Bootloader Windows 7 auswählen.
Installieren Sie .NET SDK in Version 8 indem Sie den Installationsanweisungen auf [https://dotnet.microsoft.com/en-us/download/dotnet/8.0 Download .NET 8.0] für Ihr Betriebssystem folgen.
* CTRL+ALT+ENTF drücken, um sich mit dem Pool-Account anzumelden.
=== Entwicklungsumgebung ===
* '''Visual Studio 2017''' einmal starten, damit die nötigen Verzeichnisse und Dateien angelegt werden.
Richten Sie Ihre Entwicklungsumgebung. Wir empfehlen die Verwendung von [https://www.jetbrains.com/de-de/rider/ Jetbrains Rider]. Als Student haben sie Zugriff auf eine [https://www.jetbrains.com/de-de/community/education/#students kostenlose Bildungslizenz]. Alternativ können Sie unter Windows [https://visualstudio.microsoft.com/de/vs/community/ Visual Studio Community 2022] verwenden.
* Sobald VS2017 gestartet ist, Visual Studio wieder '''schließen'''.
* Im Explorer auf das Windows-Laufwerk "S: (software)" navigieren.
* Installation der Plugins für Visual Studio (siehe auch Readme-Datei auf S:):
** Für '''MonoGame-Installation''': Verzeichnis "Visual C#" nach "C:\Users\<USERNAME>\Documents\Visual Studio 2017\Templates\ProjectTemplates" kopieren.
* Visual Studio 2017 starten.


== Windows ==
Zur Installation der IDE inkl. MonoGame folgen Sie bitte der [https://docs.monogame.net/articles/getting_started/2_choosing_your_ide_rider.html Anleitung] der MonoGame-Dokumentation.
* Stellen Sie sicher, dass Ihr PC mit dem Internet verbunden ist.


=== Visual Studio ===
===MonoGame Projekt<ref name=":0">https://docs.monogame.net/articles/getting_started/0_getting_started.html MonoGame getting started</ref>===
* Laden Sie [https://visualstudio.microsoft.com/downloads/ Visual Studio Community herunter].
Erstellen Sie ein MonoGame Projekt wie in der [https://docs.monogame.net/articles/getting_started/2_choosing_your_ide_rider.html MonoGame-Dokumentation] beschrieben.
* Folgen Sie der [https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019#step-3---install-the-visual-studio-installer Installationsanleitung von Microsoft] und achten Sie dabei darauf die folgenden Optionen unter "Workloads" auszuwählen:
** .NET Core cross-platform development
** .Net Desktop Development
** Universal Windows Platform development


=== Monogame ===
Templates zu Visual Studio hinzufügen.
* Öffnen Sie Visual Studio.
* Wählen Sie im Startbildschirm "Continue without code."
* Öffnen Sie <tt>Extensions -> Manage Extensions -> Visual Studio Marketplace</tt>.
* Suchen Sie "Monogame", installieren Sie "MonoGame project templates".
* Schließen Sie alle Visual Studio Instanzen, damit die Installation erfolgen kann.
Monogame Projekt erstellen.
* Nach Abschluss der Installation öffnen Sie Visual Studio
* Wählen Sie <tt>Create a new project -> Monogame Cross-Plattform Desktop Application (OpenGL)</tt> und nennen Sie das Projekt <tt>testMonogame</tt>.
* Das erste Erstellen wird einige Zeit dauern, da der NuGet Paketmanager das Monogame Framework herunterlädt und installiert.
* Klicken Sie auf den grünen "Playbutton" unter dem Menu. Das Projekt wird kompiliert und nach einiger Zeit erscheint ein Programmfenster gefüllt mit blauer Farbe. Das bedeutet Sie sind bereit Monogame Projekte zu entwickeln.
* (Optional) Unter "Solution Explorer" klicken Sie mit der rechten Maustaste auf <tt>testMonogame" -> "Manage NuGet Packages</tt>, hier sollten im Reiter "Install" Monogame.Framework und Monogame.Contentbuilder Version >= 3.8 erscheinen.
Monogame Content Builder installieren.
* Öffnen Sie <tt>tools -> Command line -> Developer command prompt</tt> und führen Sie nacheinander diese Befehle aus:
** <code>dotnet tool install --global dotnet-mgcb-editor</code>
** <code>mgcb-editor --register</code>
* Schließen Sie Visual-Studio und öffnen Sie Ihr "testMonogame" Projekt wieder.
* Klicken Sie im Solution Explorer mit der rechten Maustaste auf auf <tt>Content.mgcb</tt> und wählen Sie <tt>Open with</tt>.
* Wählen Sie die Option <tt>mgcb-editor-wps</tt>, klicken Sie auf <tt>Set as Default</tt> und klicken Sie auf <tt>Okay</tt>.
* Ab jetzt sollte sich  beim öffnen von <tt>Content.mgcb</tt> der Monogame Content Builder öffnen.


=== [[Resharper]] ===
Info: Falls Sie den MGCB Editor in Rider öffnen möchten und ein Doppelklick auf die Datei <code>Content.mgcb</code> nicht den gewünschten Effekt hat, versuchen Sie folgenden Workaround.
* Erstellen Sie sich [https://account.jetbrains.com/login einen Account bei Jetbrains]. Verwenden Sie ihre uni-freiburg.de Email Adresse, damit sie eine kostenlose Lizenz erhalten.
* [https://www.jetbrains.com/resharper/ Laden Sie Resharper herunter] und führen Sie die Installation aus.
* Laden Sie die Sopra spezifischen Resharper Einstellungen herunter [[Datei:Sopra-Resharper.zip]], [[Datei:Sopra-Resharper-final.zip]] und entpacken Sie diese.
* Öffnen Sie in Visual Studio <tt>Extensions -> ReSharper -> Manage Options</tt>.
* Klicken Sie rechts auf das Item <tt>This Computer</tt> und wählen Sie <tt>Add Layer->Open Settings File...</tt>.
* Wählen Sie die Datei <tt>Softwarepraktikum.DotSettings</tt>, bzw. <tt>Softwarepraktikum-final.DotSettings</tt> aus. Diese sollte nun als Eintrag "Softwarepraktikum" vorhanden sein.
* '''Achtung:''' Zur finalen Abgabe werden einige Regeln, die zuvor nur als "Hinweis" gewertet wurden, nun als "Warning" gewertet. Die Einstellungen sind also etwas strenger. Stellen Sie sicher, dass Sie zur finalen Abgabe Ihres Programms die <tt>Softwarepraktikum-final.DotSettings</tt> zur Überprüfung der Einhaltung der ReSharper-Regeln verwenden. Sie können natürlich auch bereits während des Verlaufs des Softwarepraktikums diese Regeln verwenden, um den Arbeitsaufwand zur Beseitigung der neuen Warnings am Ende des Softwarepraktikums zu reduzieren.


=== Git ===
* Öffnen Sie das Terminal in Rider (<code>View > Tool Windows > Terminal</code>) oder (<code>Ctrl+Alt+1</code>)
Folgen sie dem [[Git#Git_Installieren |Git Intallieren]] Artikel aus diesem Wiki.
* Geben Sie den Befehl <code>dotnet mgcb-editor</code> oder <code>dotnet mgcb-editor <Pfad zur Content.mgcb></code> ein.
* [https://docs.monogame.net/articles/getting_started/tools/mgcb_editor.html Wie hier beschrieben] muss der Befehl im Wurzelverzeichniss des Projektes ausgeführt werden.
* Das [https://github.com/seclerp/rider-monogame rider-monogame-plugin] bietet ebenfalls einen shortcut um den externen MGCB Editor zu öffnen.
===Git===
Sie können Git direkt von der Kommandozeile verwenden. Für etwas mehr komfort empfiehlt sich ein grafischer Client wie  z.B. [https://tortoisegit.org/ TortoiseGit] (Windows) oder eine der [https://git-scm.com/downloads/guis zahlreichen Alternativen], die extra installiert werden müssen.  Verwenden Sie Rider, ist der grafische Git-Client den Rider mitliefert empfehlenswert (Git muss trotzdem erst installiert werden).


== Linux ==
Bereiten Sie ihr Git wie beschrieben in [[Git#Git im Softwarepraktikum|Git im Softwarepraktikum]] vor.
Diese Anleitung ist für Debian geschrieben. Entsprechend können die Pfade auf anderen Distributionen leicht anders sein.  


=== Abhängigkeiten ===
==Mac OS==
* Starten sie damit die Microsoft Pakete in die Paketquellen aufzunehmen
'''Wichtig''': Da wir keinen Zugriff auf Maschinen mit aktuellem Mac OS haben, können wir bei Problemen mit Mac OS leider '''keinen Support''' leisten.
**<code>$ wget https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb -O /tmp/packages-microsoft-prod.deb </code>
** <code>$ sudo apt install /tmp/packages-microsoft-prod.deb </code>
** <code>$ sudo apt update </code>
* Danach können sie Mono und .NET Core 3.1 mit dem folgenden Befehl installieren
** <code>$ sudo apt install mono-devel dotnet-sdk-3.1 </code>


=== Rider ===
Falls Sie dennoch unter Mac OS entwickeln wollen, folgen Sie bitte der obigen Anleitung.
* Laden Sie Rider von [https://www.jetbrains.com/rider/download/#section=linux den Rider-Download] herunter
* Installieren sie es indem sie <code>$  sudo tar -xzf JetBrains.Rider-XXXX.X.X.tar.gz -C /opt </code> in ihrem Downloadordner ausführen
* Danach können sie Rider über '''/opt/Jetbrains Rider-XXXX.X.X/bin/Rider.sh''' starten.  


==== Resharper konfigurieren ====
==Ubuntu auf den Pool-Rechnern==
Die Resharperkonfiguration wird benötigt damit der Resharper die von uns geforderten Codingstandards überprüft.
=== .NET===
.NET SDK sollte auf dem Rechner bereits in einer Version >= 8.0 installiert sein. Sie können dies mit dem Befehl <code>dotnet --version</code> überprüfen.


===== Globale Konfiguration (für alle Projekte) =====
===Rider===
Kopieren Sie die Settingsdatei ([[Datei:Sopra-Resharper.zip]](Normal) oder [[Datei:Sopra-Resharper-final.zip]](final)) ins Installationsverzeichnis von Rider: '''~/.config/JetBrains/RiderXXXX.X/config/resharper-host/GlobalSettingsStorage.DotSettings'''
Laden Sie Rider auf [https://www.jetbrains.com/rider/download/#section=linux Download Rider] herunter und entpacken Sie es z.B. nach <code>~/jetbrains-rider</code>.


===== Projekt-gebundene Konfiguration =====
Sie können Rider über den Befehl <code>~/jetbrains-rider/bin/rider.sh</code> starten
Kopieren Sie die Settingsdatei in den Projektordner in dem sich auch die ''.sln'' Datei befindet: '''/pfad/zum/projektordner/{Solution Name}.sln.DotSettings'''


=== MonoGame ===
===Git===
Sie können die MonoGames Templates mit dem folgenden Befehl installieren <code>$ dotnet new --install MonoGame.Templates.CSharp </code>  
Git sollte bereits auf dem Rechner installiert sein. Sie können dies mit dem Befehl <code>git --version</code> überprüfen.


Falls dabei Probleme auftreten:
==Referenzen==
* Installieren Sie [https://github.com/MonoGame/MonoGame/releases/download/v3.7.1/monogame-sdk.run MonoGame 3.7.1]
* Führen sie <code>$ chmod +x monogame-sdk.run </code> aus
* Starten sie die Installation mit <code>$ sudo ./monogame-sdk.run </code>
* Installieren sie das Template mit <code>$ dotnet new --install MonoGame.Templates.CSharp </code> erneut


== Mac OS ==
<references />
Stellen Sie sicher, dass Ihr PC mit dem Internet verbunden ist.
 
=== Visual Studio ===
* Laden Sie [https://visualstudio.microsoft.com/vs/mac/ Visual Studio für Mac] herunter.
* Öffnen Sie die heruntergeladene .dmg Datei und wählen Sie "Visual Studio installieren".
* Sie werden nun dazu aufgefordert auszuwählen was Sie installieren wollen. Wählen Sie ".NET core" aus und installieren Sie dies.
 
=== MonoGame ===
* Laden Sie die [https://github.com/MonoGame/MonoGame/releases/download/v3.8/MonoDevelop.MonoGame_IDE_VisualStudioForMac_3.8.0.1641.mpack Monogame Erweiterung für Visual Studio (Mac)] herunter.
* Folgen Sie [https://docs.monogame.net/articles/getting_started/1_setting_up_your_development_environment_macos.html dieser Anleitung] um die Erweiterung zu installieren.
* Um ein neues Projekt zu erstellen, folgen Sie [https://docs.monogame.net/articles/getting_started/2_creating_a_new_project_vsm.html dieser] Anleitung.
 
=== Resharper ===
* Erstellen Sie sich [https://account.jetbrains.com/login einen Account bei Jetbrains]. Verwenden Sie ihre uni-freiburg.de Email Adresse, damit sie eine kostenlose Lizenz erhalten.
* Für Visual Studio (Mac OS) gibt es leider keine nutzbare Version von Resharper. Alternativ können Sie aber über den erstellten Jetbrains-Account kostenlos [https://www.jetbrains.com/rider/ Rider] herunterladen. Diese IDE beinhaltet Resharper und kann somit zum Style-Check verwendet werden.

Aktuelle Version vom 21. Oktober 2024, 10:16 Uhr

Die Arbeitsumgebung beinhaltet alle Produkte die im Sopra für die Entwicklung benötigt werden. In diesem Artikel wird beschrieben wie Sie Ihre Arbeitsumgebung einrichten und testen.

Windows / Linux

.NET

Installieren Sie .NET SDK in Version 8 indem Sie den Installationsanweisungen auf Download .NET 8.0 für Ihr Betriebssystem folgen.

Entwicklungsumgebung

Richten Sie Ihre Entwicklungsumgebung. Wir empfehlen die Verwendung von Jetbrains Rider. Als Student haben sie Zugriff auf eine kostenlose Bildungslizenz. Alternativ können Sie unter Windows Visual Studio Community 2022 verwenden.

Zur Installation der IDE inkl. MonoGame folgen Sie bitte der Anleitung der MonoGame-Dokumentation.

MonoGame Projekt[1]

Erstellen Sie ein MonoGame Projekt wie in der MonoGame-Dokumentation beschrieben.


Info: Falls Sie den MGCB Editor in Rider öffnen möchten und ein Doppelklick auf die Datei Content.mgcb nicht den gewünschten Effekt hat, versuchen Sie folgenden Workaround.

  • Öffnen Sie das Terminal in Rider (View > Tool Windows > Terminal) oder (Ctrl+Alt+1)
  • Geben Sie den Befehl dotnet mgcb-editor oder dotnet mgcb-editor <Pfad zur Content.mgcb> ein.
  • Wie hier beschrieben muss der Befehl im Wurzelverzeichniss des Projektes ausgeführt werden.
  • Das rider-monogame-plugin bietet ebenfalls einen shortcut um den externen MGCB Editor zu öffnen.

Git

Sie können Git direkt von der Kommandozeile verwenden. Für etwas mehr komfort empfiehlt sich ein grafischer Client wie z.B. TortoiseGit (Windows) oder eine der zahlreichen Alternativen, die extra installiert werden müssen. Verwenden Sie Rider, ist der grafische Git-Client den Rider mitliefert empfehlenswert (Git muss trotzdem erst installiert werden).

Bereiten Sie ihr Git wie beschrieben in Git im Softwarepraktikum vor.

Mac OS

Wichtig: Da wir keinen Zugriff auf Maschinen mit aktuellem Mac OS haben, können wir bei Problemen mit Mac OS leider keinen Support leisten.

Falls Sie dennoch unter Mac OS entwickeln wollen, folgen Sie bitte der obigen Anleitung.

Ubuntu auf den Pool-Rechnern

.NET

.NET SDK sollte auf dem Rechner bereits in einer Version >= 8.0 installiert sein. Sie können dies mit dem Befehl dotnet --version überprüfen.

Rider

Laden Sie Rider auf Download Rider herunter und entpacken Sie es z.B. nach ~/jetbrains-rider.

Sie können Rider über den Befehl ~/jetbrains-rider/bin/rider.sh starten

Git

Git sollte bereits auf dem Rechner installiert sein. Sie können dies mit dem Befehl git --version überprüfen.

Referenzen