Prerequisites
Requirements
-
Windows or Linux (amd64 or arm64)
-
Scala CLI, required to run automod
-
.NET Runtime/Desktop Runtime 8, required to run UAssetCLI/FModel (see below)
-
Typescript (optional, only if you want to use Typescript patchlets)
winget install virtuslab.scalacli
winget Microsoft.DotNet.DesktopRuntime.8
winget install OpenJS.NodeJS & :: if you want to use Typescript patchlets
npm install -g typescript & :: if you want to use Typescript patchlets
winget install vscodium & :: or, winget install Microsoft.VisualStudioCode
curl -sSLf https://scala-cli.virtuslab.org/get | bash
curl -sSLf https://dot.net/v1/dotnet-install.sh | bash
curl -o- https://fnm.vercel.app/install | bash # if you want to use Typescript patchlets
fnm install 24 # if you want to use Typescript patchlets
npm install -g typescript # if you want to use Typescript patchlets
# If snap is available, otherwise download from https://vscodium.com or https://code.visualstudio.com
snap install codium --classic # or, sudo snap install code --classic
Note
Windows amd64 is currently the best platform to use automod on due to .NET runtime parallelization issues in Linux or arm64 (e.g., UAssetCLI sometimes fail to regenerate modified.uasset
s when it is used in parallel).
Additional .NET runtime issues are also the reason why macOS is currently unsupported (e.g., UAssetCLI always fails to regenerate modified .uasset
s).
Managed Tools
These utility/modding tools will be automatically downloaded by automod when it is first launched:
-
7-zip: a high compression archiving tool
-
retoc: a fork of https://github.com/trumank/retoc that allows for handling game-specific custom format based on the game identifier.
-
repak: a fork of https://github.com/trumank/repak that allows for handling game-specific custom format based on the game identifier.
-
UAssetCLI: a stripped-down, GUI-less, and multiplatform fork of https://github.com/atenfyr/UAssetGUI
-
jd: a JSON diff tool, useful for extracting patch files
-
FModel: an Unreal Engine asset explorer, also useful for extracting patch files (only available in Windows)
Other Useful Tools
-
AESDumper: Unreal Game AES key extractor
-
Dadroit JSON Viewer: a very fast large JSON file viewer
-
UE4SS: Unreal Engine scripting system, also useful for extracting
.usmap
files- for Stellar Blade: https://github.com/Chrisr0/RE-UE4SS
To extract
.usmap
of a game, install UE4SS, launch the game, and pressCtrl + Numpad 6
. If it is successful, you can findMappings.usmap
in the game’s<game-id>\Binaries\Win64\ue4ss
folder.