Skip to content

Commit

Permalink
Merge pull request #3 from Gitjas/main
Browse files Browse the repository at this point in the history 
-Added paragraph to the readme
  • Loading branch information
@Gitjas
Gitjas authored Sep 17, 2023
2 parents df0bead + 4d05eab commit 665cdcc
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 1 deletion.
21 changes: 20 additions & 1 deletion stutterdebug/readme-stutterdebug.english.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ For debugging as a modder, installing the tool will show ingame which scripts ar

The tool functions like a normal WeiDU mod and can be installed and completely deinstalled like one. It is supposed to be installed directly onto your game. For EET, it can be installed after EET-end.
The tool is not meant to be included into a normal playthrough.
Please note: the tool can break cutscenes. Deinstall it before continuing your playthrough.

HOW TO DEBUG A SCRIPT STUTTER

1. If you encounter an issue that could be because of a repeating script action, save your game.
2. Install the Stutter Debug Tool onto your game.
3. Load the save and identify which script block of which script keeps repeating. There might be a lot of scripts being mentioned in the dialogue box, try to identify the one that leads to the issue.
4. The output will be something like "Running block 54 of scriptxy.bcs". Note this down.
5. Close the game.
6. Open Near Infinity (link below.) browse to the bcs files. Open the script file that was mentioned ("scriptxy" in our example).
7. Inside the script, search for the textline you noted down, e.g. "Running block 54 of scriptxy.bcs" (without the quotion marks). The block with this text inside is the script block you are looking for.
8. I'll stress this again: the number given in the "Running block 54 of scriptxy.bcs" is NOT the line number. It refers to the BLOCK containing this text.
9. Copy the whole script block and ask in the forums for help with the stutter if you need help.
10. Deinstall the Stutter Debug Tool to continue your playthrough.

INSTALLATION

Expand All @@ -29,7 +43,7 @@ Uninstallation will take about a minute or two, maximum.

COMPATIBILITY

The Stutter Debug Tool should be compatible with all IE games. It is meant to be installed directly onto your finished game (also EET) for debugging purposes only.
The Stutter Debug Tool should be compatible with all IE games. It is meant to be installed directly onto your finished install (also EET) for debugging purposes only.

LINKS

Expand All @@ -53,6 +67,11 @@ Ascalon - tool pre-versions and debug guide (German)

HISTORY

Version 4.1:
-French version added, by Selphira.
-Added paragraph to the readme: HOW TO DEBUG A SCRIPT STUTTER.
-Fix SoD detection for game info output.

Version 4.0:
-Modernized, restructured and cleaned up code.
-Added support for BG1.
Expand Down
19 changes: 19 additions & 0 deletions stutterdebug/readme-stutterdebug.french.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,20 @@ Pour le débogage en tant que moddeur, l'installation de l'outil montrera en jeu

L'outil fonctionne comme un mod WeiDU normal et peut être installé et désinstallé comme tel. Il est censé être installé directement sur votre jeu. Pour EET, il peut être installé après EET_End.
L'outil n'est pas destiné à être inclus dans une partie normale.
Please note: the tool can break cutscenes. Deinstall it before continuing your playthrough.

HOW TO DEBUG A SCRIPT STUTTER

1. If you encounter an issue that could be because of a repeating script action, save your game.
2. Install the Stutter Debug Tool onto your game.
3. Load the save and identify which script block of which script keeps repeating. There might be a lot of scripts being mentioned in the dialogue box, try to identify the one that leads to the issue.
4. The output will be something like "Running block 54 of scriptxy.bcs". Note this down.
5. Close the game.
6. Open Near Infinity (link below.) browse to the bcs files. Open the script file that was mentioned ("scriptxy" in our example).
7. Inside the script, search for the textline you noted down, e.g. "Running block 54 of scriptxy.bcs" (without the quotion marks). The block with this text inside is the script block you are looking for.
8. I'll stress this again: the number given in the "Running block 54 of scriptxy.bcs" is NOT the line number. It refers to the BLOCK containing this text.
9. Copy the whole script block and ask in the forums for help with the stutter if you need help.
10. Deinstall the Stutter Debug Tool to continue your playthrough.

INSTALLATION

Expand Down Expand Up @@ -50,6 +64,11 @@ Ascalon - pré-versions de l'outil et guide de débogage (allemand)

HISTORIQUE

Version 4.1:
-French version added, by Selphira.
-Added paragraph to the readme: HOW TO DEBUG A SCRIPT STUTTER.
-Fix SoD detection for game info output.

Version 4.0:
-Modernized, restructured and cleaned up code.
-Added support for BG1.
Expand Down
23 changes: 23 additions & 0 deletions stutterdebug/readme-stutterdebug.german.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ Zum Debuggen mit Moddingerfahrung installiert Ihr das Tool und verwendet die ang

Das Tool funktioniert wie ein normales WeiDU-Mod und kann daher auch vollständig wieder deinstalliert werden. Es wird einfach auf das bestehende Spiel installiert. Dies gilt auch für EET: die EET-End.exe muss (bzw. soll auch) nicht danach ausgeführt werden.
Das Tool ist nicht dazu gedacht, in eine normale Spielinstallation von Beginn an beinhaltet zu sein.
Bitte beachten: Das Tool kann Cutscenes "hängen" lassen. Deinstalliert es, bevor Ihr mit dem Durchspielen fortfahrt.

WIE MAN BEIm DEBUGGING VORGEHT
(übersetzt mit DeepL)

1. Wenn Sie auf ein Problem stoßen, das auf eine sich wiederholende Skriptaktion zurückzuführen sein könnte, speichern Sie Ihr Spiel.
2. Installieren Sie das Stutter Debug Tool in Ihrem Spiel.
3. Laden Sie den Spielstand und finden Sie heraus, welcher Skriptblock sich wiederholt. Möglicherweise werden in der Dialogbox viele Skripte erwähnt. Versuchen Sie herauszufinden, welches Skript zu dem Problem führt.
4. Die Ausgabe wird in etwa lauten: "Running block 54 of scriptxy.bcs". Notieren Sie sich dies.
5. Schließen Sie das Spiel.
6. Öffnen Sie Near Infinity (Link unten) und suchen Sie die bcs-Dateien. Öffnen Sie die erwähnte Skriptdatei ("scriptxy" in unserem Beispiel).
7. Suchen Sie innerhalb des Skripts nach der Textzeile, die Sie notiert haben, z. B. "Running block 54 of scriptxy.bcs" (ohne die Anführungszeichen). Der Block, in dem dieser Text steht, ist der gesuchte Skriptblock.
8. Ich betone es noch einmal: Die Nummer in "Running block 54 of scriptxy.bcs" ist NICHT die Zeilennummer. Sie bezieht sich auf den BLOCK, der diesen Text enthält.
9. Kopieren Sie den gesamten Skriptblock und fragen Sie in den Foren nach Hilfe, wenn Sie Hilfe benötigen.
10. Deinstallieren Sie das Stutter Debug Tool, um Ihr Spiel fortzusetzen.

INSTALLATION

Expand All @@ -41,6 +56,9 @@ https://www.baldurs-gate.de/index.php?threads/stutter-debug-wie-wann-und-warum.4
Near Infinity:
https://github.com/Argent77/NearInfinity/releases

DeepL Online Translator:
https://www.deepl.com/translator


CREDITS

Expand All @@ -50,6 +68,11 @@ Ascalon - tool pre-versions and debug guide (German)

HISTORY

Version 4.1:
-French version added, by Selphira.
-Added paragraph to the readme: HOW TO DEBUG A SCRIPT STUTTER.
-Fix SoD detection for game info output.

Version 4.0:
-Modernized, restructured and cleaned up code.
-Added support for BG1.
Expand Down

0 comments on commit 665cdcc

Please sign in to comment.