Prerequisites

Requirements

• Windows, Linux, or macOS (amd64 or arm64)

• Scala CLI, required to run automod

• VSCode or VSCodium (optional, but highly recommended)

• TypeScript (optional, only if you want to use TypeScript patchlets)

• .NET Runtime 10 (optional — Windows only if you use FModel to browse/extract assets; any platform if you regenerate Unity ttmap schemas with .ttmapgen, which drives the ttmapgen C# harness; automod auto-downloads ttmapgen.jar otherwise)

• Installing dependencies:
• Windows
• Linux
• macOS

winget install virtuslab.scalacli 
winget install Microsoft.DotNet.DesktopRuntime.10      & :: only if you want to use FModel
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 -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

curl -sSLf https://scala-cli.virtuslab.org/get | 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
brew install vscodium                                   # or, brew install --cask visual-studio-code

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.

• 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)

• ttmapgen: the asset4j ttmap generator (launched via .ttmapgen), version-matched to automod’s asset4j — used to (re)generate Unity ttmap schemas; the dll/il2cpp modes additionally require a .NET 10 runtime

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 press Ctrl + Numpad 6. If it is successful, you can find Mappings.usmap in the game’s <game-id>\Binaries\Win64\ue4ss folder.

• Bitfix with Versatile Unsigned Unreal Engine Mod Loader: to enable modding of Unreal Engine games with a signature check.