Getting started

Install UnlockedKit

Download and run the Windows installer: UnlockedKit-win-Setup.exe.

UnlockedKit is Windows-only, because the runtime it installs runs inside Windows game builds.

Sign in

Sign in with your UnlockedEditor account using email and password, or with Discord. Signing in is what enables the Unlocky assistant and cloud projects. Create an account on unlockededitor.com if you do not have one.

Add a game

Choose Add game. UnlockedKit scans your Steam libraries for supported Unreal Engine games. If your game is not found, pick its executable manually. Executables live in the game's Binaries\Win64 folder.

Install the runtime

Install the Unlocked Runtime into the game from UnlockedKit. This downloads the current runtime package and places it in the game's Binaries\Win64 folder as a dxgi.dll proxy plus an UnlockedEditor folder. See Runtime for what gets installed and how to configure it.

If the Microsoft Visual C++ runtime is missing, UnlockedKit installs it and asks you to restart Windows before launching the game.

Create a project

A project is an ordinary folder of Lua files. Create one in UnlockedKit, or open an existing folder from disk. Unlocked+ accounts can tick Store in the cloud to sync the project across devices. See Projects.

Launch the game

Start the game as usual. UnlockedKit connects automatically to the running game that has the runtime installed; there is no game or instance picker. Runtime logs stream into the output panel.

Run your first script

Create a Lua file in your project and save it. Files are validated on save and reloaded live in the game.

local player = assert(ue.get_player_character())

ue.input.bind("F3", function()
    player:Jump()
end)

return {
    on_load = function()
        ue.log.info("jump.lua loaded, press F3 to jump")
    end
}

Press F3 in the game. The log line appears in the UnlockedKit output panel.