Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen der Seite angezeigt.

--- scripting:setup [2022/06/04 20:53] – madshadow
+++ scripting:setup [2022/06/04 21:46] – madshadow
@@ Zeile 1: / Zeile 1: @@
 ====== Aufsetzen der Umgebung und Debugtools ======
-**Richte deine Entwicklungsumgebung richtig ein, für effizientes und effektives Arbeiten!**\\
+**Richte deine Entwicklungsumgebung richtig ein, für effizienteres und effektiveres Arbeiten!**\\
-//Arbeitsaufwand 5-10 Minuten.:-)//\\
+Folgende Optionen sind möglich um das Coden für Siedler stark zu vereinfachen:
+  - Visual Studio Code installieren und einrichten
-Dazu müssen folgende Schritte ausgeführt werden:
+  - Skripte extern laden
-  - Visual Studio Code installieren
+  - Eine Funktionsreferenz mit den Parametern der Lua-API
-  - Die Lua Erweiterung für Visual Studio Code installieren
+  - Das Debugscript aktivieren
-  - Einen Ordner für die externen Skripte anlegen
+  - Den LuaDebugger verwenden
-  - Die S5Lua Referenz herunterladen und entpacken
-  - Den Lua Debugger verwenden.
 ----
-===== Schritt 1: Visual Studio Code installieren =====
+===== Schritt 1: Visual Studio Code installieren und einrichten =====
+   * **Features**:
    * Hervorhebung der Syntax und schnelle Fehlererkennung.
 __Herunterladen und installieren:__\\
 https://code.visualstudio.com/download
+  * **Schritte**:
+  * Visual Studio Code starten
+  * Ganz Links den Button für Erweiterungen anklicken
+  * Nach **Lua** suchen und das erste Ergebnis **Lua Language Server coded by Lua** von sumneko installieren.
+  * Siehe auch die Anleitung von mcb dazu: https://github.com/mcb5637/s5CommunityLib/blob/master/VSCodeSetup.md
 ----
-=== Die Lua Erweiterung für Visual Studio Code installieren ===
+===== Schritt 2: Ein Ordner für externe Skripte =====
+  * **Features**:
+  * Externe Skripte können bearbeitet werden ohne das Spiel neuzustarten.
+  * **Schritte**:
+  * Navigiere in dein Siedler Mapverzeichnis *../extra2/shr/maps/user/*
+  * Erstelle einen Ordner namens **scripts**.
+  * Neue Skripte erstellst du hier als myscript.lua Datei. Beliebiger Name wählbar.
+  * Öffne den Skripteditor im Mapeditor und füge als einzige Zeile ein:
+ <code lua> Script.Load("maps\\user\\scripts\\myscript.lua") </code>
+  * Der Dateiname im Pfad muss zur angelegten .lua passen.
+----
+===== Schritt 3: Funktionsreferenz: Parameter der Lua-API =====
+  * **Features**:
+  * Zeigt dir die richtigen Parameter zu jeder Lua-API Funktion.
+* **Schritte**:
+  * Herunterladen: https://github.com/mcb5637/s5LuaReference
+  * Die .zip-Datei entpacken und in **../extra2/shr/maps/user/scripts/** entpacken.
+  * Den Ordner **../extra2/shr/maps/user/scripts/** in Visual Studio Code öffnen.. API Funktionen sollten dann erkannt werden.
+----
+===== Schritt 4: Das debugscript aktivieren =====
+  * **Features**:
+  * Typische Fehler im Skript wie fehlende Zeichen oder Aufrufen nicht existenter Funktionen (gennant Syntaxfehler) werden sofort als gemeldet.
+  * **Schritte**:
+  * Um das Debug-Script zu aktivieren, muss <code>-debuscript</code> als Kommandozeilenparameter an Siedler beim Start übergeben werden.
+  * __Möglichkeit 1__: Wenn eine Verknüpfung für Siedler auf dem Desktop vorhanden ist:
+  * Rechtsklick -> Eigenschaften -> In der Zeile hinter **Ziel:** ganz nach rechts und hinter **..settlershok.exe"** -debugscript anfügen und mit OK beenden.
+  * Wichtig ist ein Leerzeichen zwischen -debugscript und dem "-Zeichen: <code>..settlershok.exe" -debugscript</code>
+  * __Möglichkeit 2__: Im MPUpdater von Kimichura kann per Häckchen das Debug-Script aktiviert werden.
+===== Schritt 5: Den LuaDebugger verwenden =====
+  * **Features**:
+  * Ermöglicht das interaktive debuggen von Skripten, mittel break points, anzeigen aktueller Variablenbelegungen, etc.
+  * **Schritte**:
+  * Die Debugger dll herunterladen: https://github.com/mcb5637/SettlersLuaDebugger/releases/download/v0.5.9/DebugS5.zip
+  * (Falls Link nicht verfügbar, neueste Releases hier: https://github.com/mcb5637/SettlersLuaDebugger/releases )
+  * .zip entpacken und LuaDebugger.dll im Siedlerverzeichnis neben jede **settlershok.exe** legen. Das sind die Pfade:
+  * **<Siedlerverzeichnis>/bin**
+  * **<Siedlerverzeichnis>/extra1/bin**
+  * **<Siedlerverzeichnis>/extra2/bin**