DOCSEARCHbyAlgolia
Submit Docs

UE4SS Documentation

repository·main·Indexed 25 days ago

https://github.com/ue4ss-re/re-ue4ss

A Lua scripting system platform and C++ modding API for Unreal Engine 4 and 5 games. UE4SS provides tools for mod loading, property editing, and dumping utilities. It includes specialized components such as the EventViewerMod for capturing Unreal Engine call flows via ImGui and the Map Gen Editor BP for the UE4SS Map Dumper. The documentation covers installation, custom game configurations for titles like Abiotic Factor and The Outer Worlds 2, and detailed build instructions using CMake, MSVC, and xwin for cross-compilation.

Tokens
58.1K
Snippets
140
Records
387
Agent score
83%

What's inside UE4SS

  1. Overview of the UE4SS Lua API

    main
    UE4SS provides an extended Lua API that builds upon the standard Lua libraries. This API allows for scripting within the Unreal Engine environment via UE4SS. As of version 4.0.0, the API is considered mostly complete.

  2. Overview of EventViewerMod

    main
    EventViewerMod is a UE4SS C++ mod designed to capture Unreal Engine call flows and render them live using ImGui. It hooks ProcessEvent, ProcessInternal, and ProcessLocalScriptFunction concurrently. It uses a unified depth counter to maintain consistent indentation for nested and recursive call chains (e.g., PE → PI → PLSF).

  3. Explore UE4SS Features

    main

    UE4SS provides several core capabilities for Unreal Engine modding:

    • Blueprint Modloading: Load and manage mods via Blueprints.
    • Live Property Viewer and Editor: Inspect and modify object properties in real-time during gameplay.
    • Dumpers: Tools for dumping engine data, objects, and SDK information.

  6. Compatibility status for Abiotic Factor

    main

    Abiotic Factor is a Blueprint-only game currently running on Unreal Engine 5.4.4.

    Stability Warning: UE4SS is functional but considered unstable for this title. Users may experience crashes during the following actions:

    • Returning to the main menu from a game session.
    • Loading into a game session.

    UE4SS is generally stable during active play sessions, though rare crashes may still occur.

  7. Understand UE4SS Game Support (AOB only)

    main

    UE4SS provides out-of-the-box support for specific games by automatically finding Array of Bytes (AOBs) using Patternsleuth.

    Important Limitations:

    • Inclusion in the support list only means all required AOBs were successfully found.
    • Finding AOBs does not guarantee full support; other technical issues may still prevent UE4SS from working correctly in those games.
    • Support does not imply endorsement of UE4SS usage for those titles.
    • Users are responsible for complying with the game's Terms of Service.

  11. Apply code changes without restarting the game

    main

    You can reload your Lua scripts without restarting the game using one of two methods:

    • UE4SS GUI Console: Click the "Restart All Mods" button on the "Console" tab.
    • Hot Reload: Enable Hot reload in UE4SS-settings.ini. Once enabled, you can use the assigned hotkey (default is Ctrl+R) to reload mods.

  12. Automate C++ Mod Development with UE4SS CPP Template

    main

    For an automated workflow, use the UE4SS CPP Template. This template automates creating, building, and installing a mod.

    When using the new_mod_setup.bat script, it automatically checks out the latest release commit to ensure your mod is built against the correct ABI.

    Note: Changes to the build system affecting the template are pushed to the dev branch and merged into main during new UE4SS releases to maintain synchronization.