initial commit

README.md

@@ -1,43 +1,36 @@
-### Contains a small set of basic functionality required for loading other mods. It also handles initial setup and contains a mod_load_order.txt file for mod management.
+# darktideML-4linux
+Generic 64-bit linux build and a handy BASH script for the Darktide Mod Loader
+Based on Aussiemon's original mod loader (https://github.com/Darktide-Mod-Framework/Darktide-Mod-Loader)
 
-### Game updates will automatically disable all mods. Re-run "toggle_darktide_mods.bat" to enable them again.
+## Installation:
+    1. Extract the mod loader files into your game folder and overwrite existing
+    2. Run the provided script with `sh /path/to/<game_folder>/handle_darktide_mods.sh --enable`
+    3. If the patch was successful, install the Darktide Mod Framework as normal
+    4. The Darktide Mod Framework and other mods can be downloaded from
+        https://www.nexusmods.com/warhammer40kdarktide
 
-### This mod does not need to be added to your mod_load_order.txt file.
+## Disabling Mods:
+    * Disable individual mods by removing their name from your `mods/mod_load_order.txt`
+    * Run the provided script with the `--disable` argument
 
-## Installation:
-    1. Copy the Darktide Mod Loader files to your game directory and overwrite existing.
-    2. Run the "toggle_darktide_mods.bat" script in your game folder.
-    3. Copy the Darktide Mod Framework files to your "mods" directory (<game folder>/mods) and overwrite existing.
-    3. Install other mods by downloading them from the Nexus site (https://www.nexusmods.com/warhammer40kdarktide) then adding them to "<game folder>/mods/mod_load_order.txt" with a text editor.
-
-## Disable mods:
-    * Disable individual mods by removing their name from your mods/mod_load_order.txt file.
-    * Run the "toggle_darktide_mods.bat" script at your game folder and choose to unpatch the bundle database to disable all mod loading.
-
-## Uninstallation:
-    1. Run the "toggle_darktide_mods.bat" script at your game folder and choose to unpatch the bundle database.
-    2. Delete the mods and tools folders from your game directory.
-    3. Delete the "mod_loader" file from <game folder>/binaries.
-    4. Delete the "9ba626afa44a3aa3.patch_999" file from <game folder>/bundle.
+## Uninstalling Mods:
+    * Run the provided script with `--uninstall`
+    * This will disable then delete __ALL__ modded files
 
-## Updating the mod loader:
-    1. Run the "toggle_darktide_mods.bat" script at your game folder and choose to unpatch the bundle database.
-    2. Copy the Darktide Mod Loader files to your game directory and overwrite existing (except for mod_load_order.txt, if you wish to preserve your mod list).
-    3. Run "toggle_darktide_mods.bat" at your game folder to re-enable mods.
+## Updating the Mod Loader:
+    1. Run the `--disable` command
+    2. Copy the Darktide Mod Loader files to your game directory and overwrite existing
+    (except for mod_load_order.txt, if you wish to preserve your mod list).
+    3. Run the `--enable` command
 
-## Updating any other mod:
+## Updating any other Mod:
     1. Delete the mod's directory from your mods folder.
     2. Extract the updated mod to your mods folder. All settings will remain intact.
 
-## Troubleshooting:
-    * Make sure your game folder, mods folder, and mod_load_order.txt look like the images on this page: <https://www.nexusmods.com/warhammer40kdarktide/mods/19>
+
+# Troubleshooting:
     * Make sure your mods have their dependencies listed above them in the load order.
     * Remove all mods from the load order (or add '--' before each line).
     * If all else fails, re-verify your game files and start the mod installation from the beginning.
-
-## Creating mods:
-    1. Download the latest Darktide Mod Builder release: <https://github.com/Darktide-Mod-Framework/Darktide-Mod-Builder/releases>.
-    2. Add the unzipped folder to your environment path: <https://www.computerhope.com/issues/ch000549.htm>.
-    3. Run create_mod.bat or "dmb create <mod name>" in the mods folder. This generates a mod folder with the same name.
-    4. Add the new mod name to your mod_load_order.txt.
-    5. Reload mods or restart the game.
+    * Attempt to compile your own `dtkit-patch` as described in `tools/README.md`
+    * Don't bug anyone but me with bugs. File an Issue on github or https://t.me/darktideML_4linux_SUPPORT

handle_darktide_mods.sh

@@ -0,0 +1,53 @@
+
+# This script is used to enable, disable, and uninstall mods
+
+# displays usage information
+function help_user {
+    echo Please execute this script with one of the following options:
+    echo "  --enable"
+    echo "  --disable"
+    echo "  --uninstall"
+}
+
+# patches game files to enable mods
+function enable_mods {
+    echo enabling mods...
+    ./tools/dtkit-patch --patch ./bundle
+}
+
+# disables the mod patch
+function disable_mods {
+    echo disabling mods...
+    ./tools/dtkit-patch --unpatch ./bundle
+}
+
+# disables the mod patch and delete all extraneous files
+function uninstall_mods {
+    disable_mods
+    echo deleting files...
+    rm -R mods
+    rm -R tools
+    rm binaries/mod_loader
+    rm bundle/9ba626afa44a3aa3.patch_999
+    rm README.md
+    rm handle_darktide_mods.sh
+    echo done
+}
+
+
+
+### MAIN #
+if [ -z "$1" ]; then
+    echo No option selected!
+    help_user
+elif [ $1 == "--enable" ]; then
+    enable_mods
+elif [ $1 == "--disable" ]; then
+    disable_mods
+elif [ $1 == "--uninstall" ]; then
+    uninstall_mods
+else
+    echo Option not recognized!
+    help_user
+fi
+### MAIN #

tools/README.md

@@ -1,5 +1,7 @@
 # dtkit-patch
 
-Simple tool based on Aussiemon's nodejs script for patching `bundle_database.data` to load Darktide mods.
+Simple rust script built from this source: https://github.com/ManShanko/dtkit-patch
+
+Simply clone the repository and run:
+`cargo build --verbose --release --target x86_64-unknown-linux-gnu`
 
-https://github.com/ManShanko/dtkit-patch