Early Access: Documentation is actively evolving and may change without notice.

Types

Shared LuaLS type definitions used across the Kura framework, how annotations work, and links to each individual type page.

Kura ships LuaLS-friendly annotations for the kura global and for KuraDB's generated schema metadata.

Workspace setup

For the best autocomplete, add the Kura resources to your LuaLS library once:

{
  "Lua.runtime.version": "Lua 5.4",
  "Lua.diagnostics.globals": ["kura", "op"],
  "Lua.workspace.checkThirdParty": false,
  "Lua.workspace.library": [
    "./kura-core",
    "./kura-lib",
    "./kura-ui",
    "./db/kuradb/lib"
  ]
}

If you are using the extracted kuradb release instead of the source checkout, point the last path at your shipped kuradb/lib directory.

What you get

kura.lib, kura.db, and kura.ui resolve without global warnings
kura.db.tables.<tableName> autocompletes from the generated schema
kura.db.select():from(kura.db.tables.users) returns typed rows
kura.db.insert(kura.db.tables.users):values(...) validates the insert shape

Configuration

All Kura Core convars and config keys, names, accepted types, default values, and when each setting takes effect.

Gang

The Gang type definition, fields, rank structure, and how gang membership data is stored and accessed on a player.

On this page

Workspace setup