How to install UE4SS (Windows) - EscapeTheBackroomsModding/EscapeTheBackroomsModdingDocumentation GitHub Wiki

🎮 What is UE4SS

As described by their Github, its a "Lua scripting system platform, C++ Modding API, SDK generator, blueprint mod loader, live property editor and other dumping utilities for UE4/5 games." If this don't make sense, it allows modders to inject code into Unreal Engine 4 games like Escape the Backrooms and these make the mods you play!

📦 Downloads

  • Download Escape the Backrooms on Steam
  • From the UE4SS Github download the UE4SS_Xinput_v2.5.2.zip zip file
  • In our official Discord download some mods from the 🎨|mod-downloads channel

⚙️ Setting Up UE4SS

  1. Open Steam and navigate over to Escape the Backrooms
  2. Click on the gear icon and navigate to Manage > Properties... > Installed Files > Browse... this will open your file explorer
  3. Navigate over to EscapeTheBackrooms > Binaries > Win64
  4. Unzip the UE4SS_Xinput_v2.5.2.zip or UE4SS_v3.0.1.zip zip file and enter it
  5. Move the contents of the UE4SS_Xinput_v2.5.2.zip or UE4SS_v3.0.1.zip zip file into the Win64 folder
  6. Open the UE4SS-settings.ini file and navigate to the debug section,set GuiConsoleVisible to 1, and ConsoleEnabled to 1
  7. Open the Mods folder and open Mods.txt and set BPModLoaderMod to 1

🖥️ Installing Different Mods

Unlike other traditional mods for different games like Minecraft, UE4SS has many types of mods and they are installed in different places. You can find your mod type in 🎨|mod-downloads under the tags of the post or in the description of the post.

🧠 Logic Mods

  1. Navigate to EscapeTheBackrooms > Content > Paks > LogicMods if the folder is not there create it
  2. Paste your LogicMod.pak file in
  3. Start your game and click on the UE4SS Debugging Tools (OpenGL 3) popup and on the BP Mods tab check if your mod is loaded
  4. If the mod is configured correctly it should contain information under the mod tab and maybe the buttons it uses
  • Read the mod post in 🎨|mod-downloads for further instructions

🦾 DLL Mods (C++)

  1. Navigate to EscapeTheBackrooms > Binaries > Win64 > Mods if the folder is not there restart the guide
  2. Paste your mod folder DLLModFolder into the Mods folder (you might need to unzip it), this will contain a folder named dlls with the mod's main.dll in it. There's other example mods in the folder that show how its done too
  3. In the mods.txt add DLLModFolder = 1 on its own line. Change DLLModFolder to the name of the mod folder
  4. Download the UE4SS-cppsdk.dll from the UE4SS GitHub releases page and put it in the Mods folder
  5. Start your game and click on the UE4SS Debugging Tools (OpenGL 3) popup and check in the console if the mod loaded
  6. Read the mod post in 🎨|mod-downloads for further instructions

📜 Lua Mods

  1. Navigate to EscapeTheBackrooms > Binaries > Win64 > Mods if the folder is not there restart the guide
  2. Paste your mod folder LuaModFolder into the Mods folder (you might need to unzip it), this will contain a folder named Scripts with the mod's main.lua in it. There's other example mods in the folder that show how its done too
  3. In the mods.txt add LuaModFolder = 1 on its own line. Change LuaModFolder to the name of the mod folder
  4. Start your game and click on the UE4SS Debugging Tools (OpenGL 3) popup and check in the console if the mod loaded
  5. Read the mod post in 🎨|mod-downloads for further instructions

📦 Installing Patch Paks (Texture Replacement Mods)

  1. Navigate to EscapeTheBackrooms > Content > Paks > ~mods if the folder is not there create it
  2. Paste your ModName_P.pak file in
  3. Start your game and check it the mod worked. There’s no drop-down in the menu to check if they worked so these are not supported but you don’t need the UE4SS mod loader for these mods
  4. Read the mod post in 🎨|mod-downloads for further instructions

☕ Video Installation Guide

A video by mythical_alt on the Discord shows how to install the UE4SS mod loader

https://github.com/EscapeTheBackroomsModding/EscapeTheBackroomsModdingDocumentation/assets/85449670/cd9790d0-033a-4041-b3e2-b0d1069d8ba6

📋 Credits

Here's a few people who made this guide and modding for Escape the Backrooms possible

  • Giuca002: Writing this guide
  • Mythical: Filming the video and additional help
  • Contributors of UE4SS: Their GitHub is here