Cod3x

If you've written OpenMW-Lua before, then you know one of the first problems you'll run into is its documentation. The system OpenMW developers built is quite complex and unorthodox for a Lua API. It's not bad, but it's unusual, and I'd argue it requires highly specialized tooling in order to... actually work.

What's more, OpenMW's official Lua documentation is actually riddled with fundamental inaccuracies it makes no attempt whatsoever to correct. For instance, as a scripter, you might've noticed `:teleport` only works in a GLOBAL script. OpenMW's LDT and Teal docs would never prevent you from making this class of mistake.

Cod3x does that and more.

Cod3x is not a normal OpenMW mod. You do not enable it in the OpenMW launcher.

Cod3x is a set of Lua Language Server annotations for OpenMW-Lua scripters. It gives your editor better autocomplete, hover docs, and context-aware warnings for openmw.* APIs.

Firstly, you need an editor that supports Lua Language Server. This is essentially all of them. For VSCode and forks, install the Lua plugin by Sumneko.

Download Cod3x manually from Nexus and extract it somewhere stable.

For example:

C:/Modding/Tools/Cod3x/

or on Linux:

/home/you/Modding/Tools/Cod3x/

The folder should contain files like:

openmw.lua

omw_context_plugin.lua

.luarc.json

Then, copy the .luarc.json from `examples` into your the root folder of your mod, open the .luarc.json in your favorite text editor, and replace both /absolute/path/to/Cod3x/ instances with the actual location you extracted Cod3x to.

Cod3x is not just "the OpenMW annotations converted to LuaLS." Those already exist. Cod3x is a curated, LuaLS-native annotation pack plus a real LuaLS plugin built specifically for OpenMW-Lua scripting.

The official OpenMW docs and LDT annotations are valuable references, and the community LLS conversions helped prove there was demand for this. Cod3x goes further: it fixes inherited type-correctness issues, adds context awareness, and gives LuaLS active plugin logic instead of only static stubs.

OpenMW Lua scripts do not all run in the same world. A global script, player script, local object script, menu script, and load script have different API access. Cod3x lets you declare that context directly in the file:

---@omw-context