Projects
How UnlockedKit projects, the editor, and the runtime connection work.
A project is a folder of .lua files. UnlockedKit does not impose a layout: nest files and subfolders however you like.
Creating and opening projects
- New project creates a folder managed by UnlockedKit in its application-data folder under
%APPDATA%. - Open from disk registers an existing folder. It stays where it is; nothing is copied.
- Store in the cloud (Unlocked+ and Unlocked++) keeps the project in sync with your account. See Cloud projects.
Removing a project from UnlockedKit only unregisters it. Files on disk are never deleted.
Editor
- Open several files in tabs. Changes auto-save.
- Each save validates the file and reloads it live in the connected game.
- Runtime logs from
ue.logandprintstream into the output panel.
Runtime connection
Projects are deliberately independent from installations. UnlockedKit does not ask you to pick a game or an instance: it connects automatically to the installed game that is currently exposing the runtime pipe. Lua source is sent over a local named pipe, and the MCP server that Unlocky uses listens on http://127.0.0.1:3001/mcp.
Script lifecycle
A file can return a table of callbacks to react to loading, world changes, ticks, and unloading. See Lifecycle in the Lua API.