Release UE4SS mod (#98)

.github/workflows/release-mod.yml

@@ -0,0 +1,33 @@
+name: Release CodeRevealer
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  zip:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Create directory structure
+        run: |
+          mkdir -p mod-dist
+          mkdir -p CodeRevealer/Scripts
+          touch CodeRevealer/enabled.txt
+          cp ue4ss_mod/main.lua CodeRevealer/Scripts/main.lua
+
+      - name: Zip files
+        run: |
+          zip -r mod-dist/CodeRevealer.zip CodeRevealer
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: mod-dist
+
+permissions:
+  contents: write

.vscode/settings.json

@@ -29,5 +29,11 @@
     "less",
     "postcss",
     "scss"
+  ],
+  "Lua.diagnostics.globals": [
+    "RegisterHook"
+  ],
+  "Lua.diagnostics.disable": [
+    "undefined-global"
   ]
 }

README.md

@@ -2,12 +2,14 @@
 
 # PD3 Vault Cracker
 
-A tool to help you crack the vault in Payday 3. Enter your 2-4 digit code and it will tell you the possible combinations. Go get those no mask runs!
+A website to help you crack the vault in Payday 3. Enter the 2-4 digits highlighted on the in-game keypad and it will tell you the possible combinations. Go get those no mask runs!
 
 Click [here](https://savagecore.github.io/pd3-vault-cracker/) to view it.
 
 Inspired by [this](https://www.reddit.com/r/paydaytheheist/comments/15jvvpq/payday_3_beta_vault_code_generator_from/) Reddit post.
 
+There is also a [UE4SS](https://modworkshop.net/mod/47771) mod in the `ue4ss_mod` [folder](https://github.com/SavageCore/pd3-vault-cracker/tree/main/ue4ss_mod) of this repo, it prints the door/vault code to the console.
+
 ## Development
 
 1. Clone the repo

package.json

@@ -1,7 +1,7 @@
 {
   "name": "pd3-vault-cracker",
   "private": true,
-  "version": "0.1.5",
+  "version": "0.1.6",
   "type": "module",
   "scripts": {
     "dev": "vite --open",

ue4ss_mod/README.md

@@ -0,0 +1,20 @@
+# CodeRevealer
+
+> Prints the Payday 3 door/vault code combination to the UE4SS console.
+
+Thanks to [fm666venom](https://www.unknowncheats.me/forum/payday-3-a/614083-code-doors-vault.html) at UnknownCheats for the code. I'm just hosting it here as a standalone mod.
+
+## Installation
+
+1. Install [UE4SS](https://modworkshop.net/mod/47771).
+2. Download the latest release of `CodeRevealer.7z` from the [releases](https://github.com/SavageCore/pd3-vault-cracker/releases/latest/download/CodeRevealer.7z).
+3. Extract the contents of the archive to the mods folder `PAYDAY3\PAYDAY3\Binaries\Win64\Mods`. You should now have a CodeRevealer folder containing a blank `enabled.txt` file and a `Scripts` folder with the `main.lua` file.
+4. Enable the console in UE4SS. To do this, edit the `UE4SS-settings.ini` file in the UE4SS folder and set either `ConsoleEnabled` or both `GuiConsoleEnabled` and `GuiConsoleVisible` to `1`. For example:
+
+```ini
+ConsoleEnabled = 0
+GuiConsoleEnabled = 1
+GuiConsoleVisible = 1
+```
+
+5. Start the game and a console window or GUI console should now launch alongside it. Once you start a heist, the door/vault code combination will be printed to the console.

ue4ss_mod/main.lua

@@ -0,0 +1,15 @@
+print("[CodeRevealer] Mod loaded\n")
+
+local lastLoggedCode = ""
+
+RegisterHook("/Script/Starbreeze.SBZCodeViewerInterface:UpdateCodeViewer", function(self, generatedCodes, trueCodeIndex)
+  -- Format the current code as a four-digit string
+  local currentCode = string.format("%04d", generatedCodes:get()[trueCodeIndex:get() + 1])
+
+  -- Check if the current code is different from the last logged code
+  if currentCode ~= lastLoggedCode then
+    print("\n[CodeRevealer] DOOR/VAULT CODE: " .. currentCode .. "\n\n")
+
+    lastLoggedCode = currentCode
+  end
+end)