th3w1zard1

A simple CLI to easily compare KOTOR file formats. This is a very simple CLI to PyKotor. If you find TSLPatcher isn't patching the resulting files in the way you want, you can use this tool to compare your manual changes to the resulting TSLPatcher result. You can also use it to compare entire installations, directories, or single files. Why KotorDiff? It is (or should be) common knowledge that Kotor Tool is not safe to use for anything besides extraction. But have you ever wondered why that is? Let's take a look at a .utc file extracted directly from the BIFs (the OG vanilla p_bastilla.utc). Extract it with KTool and name it p_bastilla_ktool.utc. Now open the same file in ktool's UTC character editor, change a single field (literally anything, hp, strength, whatever you fancy), and save it as p_bastilla_ktool_edited.utc. KotorDiff's output: Using --path1='C:\Users\nodoxxxpls\Downloads\p_bastilla_ktool_edited.utc' Using --path2='C:\Users\nodoxxxpls\Downloads\p_bastilla_ktool.utc' Using --ignore-rims=False Using --ignore-tlk=False Using --ignore-lips=False Using --compare-hashes=True Using --use-profiler=False GFFStruct: number of fields have changed at 'p_bastilla_ktool_edited.utc': '72' --> '69' Field 'Int16' is different at 'p_bastilla_ktool_edited.utc\HitPoints': --- (old)HitPoints +++ (new)HitPoints @@ -1 +1 @@ -18 +24 Field 'LocalizedString' is different at 'p_bastilla_ktool_edited.utc\FirstName': --- (old)FirstName +++ (new)FirstName @@ -1 +1 @@ -Bastila +31360 Field 'Int16' is different at 'p_bastilla_ktool_edited.utc\CurrentHitPoints': --- (old)CurrentHitPoints +++ (new)CurrentHitPoints @@ -1 +1 @@ -20 +24 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\0\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -3 +94 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\2\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -39 +98 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\3\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -43 +55 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\4\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -44 +107 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\5\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -55 +3 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\6\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -94 +39 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\7\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -98 +43 Field 'UInt16' is different at 'p_bastilla_ktool_edited.utc\FeatList\8\Feat': --- (old)Feat +++ (new)Feat @@ -1 +1 @@ -107 +44 Field 'LocalizedString' is different at 'p_bastilla_ktool_edited.utc\Description': --- (old)Description +++ (new)Description @@ -0,0 +1 @@ +-1 Field 'String' is different at 'p_bastilla_ktool_edited.utc\Subrace': --- (old)Subrace +++ (new)Subrace @@ -1 +0,0 @@ -0 ^ 'p_bastilla_ktool_edited.utc': GFF is different ^ --------------------------------------------------- 'p_bastilla_ktool_edited.utc' DOES NOT MATCH 'p_bastilla_ktool.utc' Sheesh! I bet you can't even guess which field I modified! Again I changed a singular field! What is all this nonsense that KTool did to my character sheet? Moral: Don't use KTool to modify files. It seems to have the incorrect field types defined internally and doesn't respect the original file when saving a new one. But KotorDiff saved the day here and outputted exactly what happened on save. How to use: Simply run the executable. It'll ask you for 3 paths: PATH1 Path to the first K1/TSL install, file, or directory to diff. PATH2 Path to the second K1/TSL install, file, or directory to diff. OUTPUT_LOG File name/path of the desired output logfile (defaults to log_install_differ.log in the current directory) If you point PATH1 and PATH2 to two KOTOR installs, it will ONLY compare the Override folder, the Modules folder, the Lips folder, the rims folder (if exists), the StreamWaves/StreamVoices folder, and the dialog.tlk file. This was a design choice to improve how long the differ takes to finish. This includes any subfolders within the aforementioned folder names. Supported filetypes/formats: TalkTable files (TLK) Any GFF file (DLG, UTC, GUI, UTP, UTD, GIT, IFO, etc) Any capsule (ERF, MOD, RIM, SAV, etc) Not supported: NCS, NSS, ITP Any file format that's not supported will have its SHA256 hash compared instead. CLI Support: This is a very flexible tool. You can send it command line arguments if you would like to use it in a 3rd party tool. Run `kotordiff.exe --help` to get a full syntax. If there's an error, the exit code will be 3 (if err is known by my code) or 1 (some sys error loading the tool). If the two paths match, the exit code will be 0. If the two paths don't match, exit code will be 2. You can utilize these error codes to utilize KotorDiff in a customized 3rd party script, or add-on to WinMerge/WinDirStat, possibilities are endless. FAQ: I am struggling to read the diff output, why is it saying +/-/@38924 and what does it mean? A: GIT Diff is a standardized output format that has been widely adopted and used since probably the 80s/90s. https://stackoverflow.com/a/2530012/4414190 is by far the best explanation i've seen, but honestly ask ChatGPT to explain it further if needed, or send me a pm if something doesn't make sense! Couldn't I just open my two files with Holocron Toolset/ERFEdit/K-GFF etc? You could, but for me it became tedious to manually compare them side by side, expanding every node etc. Leave alone completely multiple files. This tool allows you to simply input two paths and have the full differences outputted and logged. A main benefit is it'll show you the exact GFF paths that differ. Output such as `Missing struct: "EntryList\5\RepliesList\3" {contents of the struct}` has been very useful. Why is my antivirus is flagging this? This is a false-positive and there's nothing I can do. Python source scripts are compiled to executables using PyInstaller, but unfortunately some antivirus's have been known to flag anything compiled with PyInstaller this way. The problem is similar to why your browser may warn you about downloading any files with the .EXE extension. This whole tool is open source, feel free to run directly from the source script: https://github.com/NickHugi/PyKotor/blob/master/Tools/KotorDiff/src/kotordiff/__main__.py There's a well-written article explaining why the false positives happen on their issue template: https://github.com/pyinstaller/pyinstaller/blob/develop/.github/ISSUE_TEMPLATE/antivirus.md TLDR: PyInstaller is an amazing tool, but antiviruses may flag it. This is not the fault of PyInstaller or my tool, but rather the fault of how some scummy users have chosen to use PyInstaller in the past. Please report any false positives you encounter to your antivirus's website, as reports not only improve the accuracy of everybody's AV experience overall, but also indirectly supports the PyInstaller project. Source code: https://github.com/NickHugi/PyKotor/blob/master/Tools/KotorDiff/ Credit: @Cortisol for creating the PyKotor library (i.e., 90% of the code for this tool)

Please see http://github.com/th3w1zard1/KOTORModSync for the main repo. Please report any bugs or problems you encounter. While I test this heavily, it's difficult to find any and all problems when incorporating 200+ mod's instructions across dozens of operating systems and platform combinations. If you happen to notice something odd or out of place, please report them. KOTORModSync is a multi-mod installer for KOTOR games that makes it easier to install and manage mods. I usually install the Reddit mod build every year or so. The process takes about an hour and it's repetitive moving files, running tslpatcher, deleting specific files, and occasionally renaming some files. The last time I installed the modbuild I made a mistake on a single different step, 3 times in a row. Most mistakes require a full restart from the beginning. This is tedious, so I decided to create an installer creator in C# to simplify the process. Goals Mod creators work really hard on their mods. It's the least we can do to install them and use them, right? However, who wants to reinstall to vanilla and spend several hours reinstalling mods, just to add 1 or 2 extra mods on top of it? Other mod managers I've tried were either too difficult to configure, require significant changes to a hard-to-understand configuration file, or only provided limited functionality for defining new mods. KOTOR mods definitely can have complex dependency relationships with each other in regard to compatibility, due to the nature and age of TSLPatcher. Usage If you are an end user just wanting to install some mods, simply load up the instruction files provided, choose the mods you want from the left list and any options, and press 'Start main install' Watch Xuul's tutorial video here: Effortless Modding with Kotor Mod Sync: The Ultimate Guide for Star Wars KOTOR Mods (youtube.com) If you are a mod developer, this program contains a full-blown instruction editor that'll allow you to quickly create instructions for your mod and define its compatibility with other mods. See Dependencies/Restrictions and InstallBefore/InstallAfter explanation - Pastebin.com for more information. See the video tutorial here: Creating involved instructions for KOTORModSync - YouTube Features Can install the https://kotor.neocities.org/ mod builds in about 20 minutes from a vanilla install. Supports TSLPatching on mac/linux without wine! Select the individual mods you want for an install - the dependencies and incompatibilities will automatically be chosen and sorted. This means end users don't have to worry about specific instructions regarding other mods in the list. All the compatibility steps are handled internally by KOTORModSync and the default instructions files provided here. An end user simply can select the mods they want to install in the left list, and any customizations if they like, and simply press 'Install All' to have everything installed automatically. This program has a built-in GUI editor and an installer packed into one. Modbuild creators can create instructions with little to no knowledge of the format and easily share them with end users. End users can install everything from the instruction file with a simple click of a button. Edit any instructions and verify the configuration with built-in tools. Some support to dry run an install. A flexible configuration editor and parser utilizing TOML syntax. This is very user-friendly and similar to INI which TSLPatcher already uses and most modders are used to. Create instructions files with complex dependency structures for multiple mods, and have end users install everything exactly according to the instructions created. No more manually copying/deleting files: KOTORModSync handles all of that for your end user. Platforms KOTORModSync is a cross-platform 32-bit and 64-bit .NET application. It is compatible with the following operating systems: Windows 7 and 8: Compatible if running .NET Framework 4.6.2 or higher. Windows 10 and 11: Fully compatible with any Windows release. Linux and Mac: Fully compatible - choose one of the two that match your operating system. Users do not need to download any additional runtimes: everything is self-contained within the application. Linux You may need additional X11 libraries. In order to get this working on WSL, for example, I had to install the following packages: sudo apt install libsm6 libice6 libx11-dev libfontconfig1 libx11-6 libx11-xcb1 libxau6 libxcb1 libxdmcp6 libxcb-xkb1 libxcb-render0 libxcb-shm0 libxcb-xfixes0 libxcb-util1 libxcb-xinerama0 libxcb-randr0 libxcb-image0 libxcb-keysyms1 libxcb-sync1 libxcb-xtest0 Then you can simply run in a terminal like this: ./KOTORModSync If you run into problems with the Linux or Mac builds, please contact me and I'll try to get a fix ready for the next release. Credit Snigaroo This man saved me a countless amount of hours. I'd still be struggling through game glitches and mod-specific instructions I didn't understand. Actually, I'd probably still be on Dantooine trying to determine why I'm getting visual glitches and crashes which he solved with the one-word message 'grass'. Cortisol Created HoloPatcher and the PyKotor library that KOTORModSync uses to patch mods. These projects are the main reason KOTORModSync can be supported on Mac/Linux. While the PyKotor/HoloPatcher projects have had some issues, this guy was more or less available for comment if I had questions on how I could fix any remaining problems myself. JCarter426 There were so many KOTOR-specific things to learn, without his help I'd still be trying to deserialize encapsulated resource files. His time and patience were incredibly useful to the project and this project would be impossible without him. Testers: Lewok from r/KOTOR Thank you for helping test that obnoxious UAC elevation problem legacy Windows apps like TSLPatcher have. Other notable users Fair-Strides Provided the perl source code of TSLPatcher on GitHub, and generally maintained the TSLPatcher project in Stoffe's absence. Stoffe Creator of TSLPatcher Thank you to the entire KOTOR modding community for what you do. KOTORModSync - Official Documentation.txt