REE Enum Injector

REFramework plugin for injecting custom enum entries for RE Engine games. Since a lot of the games have hardcoded object IDs, this can be necessary for injecting custom content.

Requirements

Requires REFramework with Plugin version >= 1.14.0 (Nightly build 01165 or above as of right now), or whichever stable release newer than v1.5.9.1.

Installation

• Download the latest release
• Place the .dll into your game's reframework/plugins folder.

Config support

The plugin automatically scans the reframework/data/injected_enums folder for .txt files containing custom enum entries. A .txt file can contain any number of enums. The syntax is @app.EnumClassname to set the enum for the following assign statements and Label 12345 pairs, one per line, of a label and value that should be added to the enum. Example:

@app.EnumClassname
Label 12345
Label2 5678

@app.Enum2
NewLabel 42

Lua API

The plugin adds a global content_injector object with the following methods:

content_injector.add_enum_entry(enum: string|TypeDefinition, label: string, value: integer)

This adds a single entry to an enum.

Example: content_injector.add_enum_entry('app.ItemIDEnum', 'It038887', 38887)

content_injector.add_enum_entries(enum: string|TypeDefinition, entries: table<string,integer>)

This adds all the entries from the label-value table as new values to the target enum. Example:

content_injector.add_enum_entries('app.ItemIDEnum', {
    Label1 = 1234,
    Label2 = 4567,
})

To verify functionality ingame:

sdk.find_type_definition('System.Enum'):get_method('GetNames'):call(nil, sdk.find_type_definition('app.TopsStyle'):get_runtime_type()):add_ref()
sdk.find_type_definition('System.Enum'):get_method('GetValues'):call(nil, sdk.find_type_definition('offline.gamemastering.Map.ID'):get_runtime_type())[326].value__

Building

Requires cmake and a valid windows c++ compiler

# The debug build enables extra logging for troubleshooting
cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build

Then copy the build/Debug/content_injector.dll into the game's reframework/plugins folder.