FAQ / Troubleshooting

Table of Contents

Can I use this on Steam/Epic/Gamepass?

Yes to Steam and Epic. Gamepass is not currently supported.

Can I use this on Steam Deck/Linux/Mac?

Yes, through a compatibility layer. The SDK only works on a Windows executable, but you can just run that version on Linux/Mac instead. Since there’s no official Linux release for either game, and no official Mac release for WL, you’re likely already doing this already.

Steam Deck/Linux

In Steam, set the game’s launch options to:

WINEDLLOVERRIDES="dsound=n,b" %command%

Once you get in game, open console by pressing tilde twice, and double check there’s no proton errors detected. You may have to switch proton builds a few times, the exact builds that work seems to vary between people for reasons we haven’t worked out. Generally though, recent builds of Proton GE seem to have better results - and you may find it easier to install them via ProtonUp-Qt.

Once you manage to load in without any proton errors, you’re all set up, you can continue following all other instructions.

Mac

While we believe it’s possible, we don’t properly understand the process for running the Windows executable on a Mac. If you do, let us know, and we can fill this section in properly.

Can I use this alongside hotfix or pak mods?

Yup, they’re all fully compatible - though as always, specific mods may have issues when used together.

Is it safe to install the SDK?

Depends on what you mean by safe.

Note all the following answers relate to normal, “well behaved” mods. While we’ve never had an incident, a malicious mod could break all the rules.

Will the SDK delete/corrupt my saves?

In general, no. Some specific mods may be more risky.

Mods which add new items/characters generally require a starting new character. Loading an unmodded character with these, or a modded one without them, could possibly cause issues. If you ever make this mistake, the disconnect console command will quit without saving.

Will I get banned for using the SDK?

No.

The 2K Terms of Service state that, if you use mods to grief/hack their servers, they reserve the right to ban you (from SHiFT, not the game). They also say they’ll ban you if you grief/hack by other means - using mods isn’t the relevant part. In practice, most people recommend staying away from matchmaking because this is essentially never enforced, even in cases it clearly should be.

Will the SDK prevent me getting achievements/give me achievements I haven’t earned?

No. The SDK does not interact with achievements in any way. Specific mods may make getting achievements easier/harder.

Will the SDK give me a virus?

The SDK itself will not - it does occasionally get caught in a scan. To be safe make sure you only ever download it from the official github, linked in the sidebar.

While we’ve never had an incident, it is theoretically possible for SDK mods to contain a virus. SDK mods are not sandboxed, they can run arbitrary code on your system, and we do not actively review their contents. Treat them like installing any other program on your system.

Tilde isn’t opening the console / I want to use a different console key

Tilde isn’t quite a standardised key, so on some keyboard layouts a different character sends the same signal to the game. You can check this site for a reference.

To rebind the console key, create a new file <game>\OakGame\Binaries\Win64\Plugins\unrealsdk.user.toml, and open it in notepad. Add the following content, substituting the key as appropriate:

[unrealsdk]
console_key = "F1"

How do I unbind a Keybind?

Set it to the same thing it was already bound to.

My game is crashing…

When I open one of the entries in the BL3 Mod Menu

Update the sdk, this was fixed in version 1.3. The BL3 update on 2024-08-08 caused older versions of the BL3 Mod Menu to crash when creating a slider or keybind option.

How do I use this with the plugin loader for OpenHotfixLoader/BL3HM/other dll mods?

For convenience, the SDK zip comes with a plugin loader pre-packaged, the sdk itself is a plugin just like everything else. You can just throw these other mods into the Plugins folder, and everything should keep working as before.

How do I use this with dxvk/other programs hooking d3d11.dll?

If you’ve previously installed mods, they probably came with a d3d11.dll plugin loader, which would cause conflicts. The sdk ships with a different plugin loader precisely for this, if you still have a d3d11.dll, you can simply overwrite it with dxvk.

I still have an old plugin loader, is this a problem?

Generally, no. Having multiple plugin loaders is not a problem, since once a plugin is loaded, other pluginloaders won’t do anything to it.

There are some niche known issues with using specific dlls as pluginloaders. The SDK has changed dlls a few times to try avoid them:

  • d3d11.dll

    The oldest version of this does not allow the SDK to load it’s dependencies correctly, so the SDK itself will completely fail to load. The SDK never shipped with this version, but if you installed older modding tools you might still have one. SDK version 1.0 shipped with a version which addressed this.

    When using this plugin loader, your steam overlay (and perhaps other overlay programs) stops functioning.

    If you want to install dxvk, it will also need to override this same dll.

  • xinput1_3.dll

    This shipped with SDK version 1.1.

    When playing under Proton, you had to use WINEDLLOVERRIDES="xinput1_3=n,b". Setting this variable breaks all controller input, even without any mods, and in multiple other games.

  • dsound.dll

    This has shipped since SDK version 1.2.

    No known issues \o/

This site uses Just the Docs, a documentation theme for Jekyll.