A TurtleWoW DLL plugin that gives addon and mod authors direct access to DBC game data from Lua. It exposes RQ_* globals for looking up rows in any supported DBC by numeric ID, and follows the same loader convention as nampower: the DLL exports a Load() function called by the TurtleWoW plugin loader on startup.

DBC files are read directly from the game's MPQ archives on first access and cached for the lifetime of the session. Patch MPQs are respected: when multiple archives contain the same DBC file, the highest-priority one wins.

local row, err = RQ_GetRow(dbc_name, id [, locale])

Looks up id in any supported DBC by name. Returns the row as a table on success, or nil plus an error string on failure. The optional locale argument controls how localized string fields are presented (see Locale handling).

local major, minor, patch = RQ_GetVersion()

Returns the Reliquary version as three integers.

Each supported DBC has a dedicated function that pre-selects the DBC name. All return row, err with the same semantics as RQ_GetRow.

Spell system

Items

Characters, classes, races

World and map

Creatures and factions

Skills

Miscellaneous

local rows, err = RQ_GetRows(dbc_name [, locale])

Returns an array of all rows in the named DBC. Each row is a full table with both named and positional keys, identical to RQ_GetRow output. Returns an empty table if the DBC has no rows. On failure, returns nil plus an error string.

local rows, err = RQ_FindRow(dbc_name, field, value [, locale])

Returns an array of all rows where field exactly equals value. Comparison is case-sensitive and type-sensitive. The field parameter accepts both raw schema names ("name_enUS") and locale-stripped names ("name", which resolves to "name_enUS" by default). The value type must match the schema: numbers for integer/float fields, strings for string fields. Returns an empty table if no rows match.

local count, err = RQ_GetRowCount(dbc_name)

Returns the total number of rows in the named DBC as an integer.

local row, err = RQ_GetRowByIndex(dbc_name, index [, locale])

Returns the row at 1-based sequential index. Pair with RQ_GetRowCount to iterate rows one at a time without loading the entire DBC into Lua. Returns nil plus an error string for out-of-range indices.

-- Build a name-to-id lookup table for all zones
local areas = RQ_GetRows("AreaTable")
local zone_by_name = {}
for i = 1, table.getn(areas) do
  zone_by_name[areas[i].name] = areas[i].id
end

-- Find all zones on Kalimdor (mapId = 1)
local kalimdor = RQ_FindRow("AreaTable", "mapId", 1)

-- Iterate one row at a time
local count = RQ_GetRowCount("AreaTable")
for i = 1, count do
  local row = RQ_GetRowByIndex("AreaTable", i)
  -- process row
end

A successful lookup returns a Lua table with both named and positional keys:

local row = RQ_GetSpell(133)
-- Named:      row.id, row.name, row.school, row.category, ...
-- Positional: row[1], row[2],   row[3],     row[4],       ...

Positional keys follow column order as defined in the DBC schema and skip locale variants that were filtered out (see below). Named and positional access refer to the same values.

Localized string fields are named <field>_<locale> in the raw DBC schema (e.g. name_enUS, name_frFR). The optional locale argument to RQ_GetRow controls how these are presented:

Typed lookup functions always use the enUS default. Bulk and iteration functions (RQ_GetRows, RQ_FindRow, RQ_GetRowByIndex) accept the same optional locale argument. Use RQ_GetRow with an explicit locale if you need another language.

Supported locales: enUS, koKR, frFR, deDE, zhCN, ruRU, esES, ptPT.

Bad argument types or counts raise a hard Lua error with a usage string. All other failures return nil plus a descriptive error string:

Typed lookup functions and bulk/iteration functions produce equivalent messages prefixed with their own function name.

Lua 5.0 compatibility. WoW 1.12.1 uses Lua 5.0, which differs from later versions in a few ways that affect Reliquary usage:

• String methods cannot be called with : syntax (err:find(...) fails). Use the module-level functions instead: string.find(err, "...").
• math.huge is not defined. Use large numeric literals such as 2^53 when you need values outside the normal range.
• lua_isstring returns true for numbers, so passing a number where a string is expected (e.g. a DBC name) will not trigger a usage error; the number will be coerced to a string and treated as an unknown DBC name.
• Similarly, lua_isnumber returns true for numeric strings, so "133" is accepted wherever a numeric ID is expected.

Lazy loading. Each DBC is parsed on first access and cached for the remainder of the session. The first call to any function that touches a given DBC may be slightly slower than subsequent calls.

Logging. Reliquary writes warnings and errors to Logs\Reliquary.log. Normal successful lookups produce no log output.

Check for RQ_GetVersion before calling any RQ_* function. This lets your addon degrade gracefully when Reliquary is not installed.

if not RQ_GetVersion then
    DEFAULT_CHAT_FRAME:AddMessage("MyAddon requires Reliquary.")
    return
end

local major, minor, patch = RQ_GetVersion()
-- e.g. 0, 1, 0

local row, err = RQ_GetSpell(133)
if not row then
    DEFAULT_CHAT_FRAME:AddMessage("Reliquary: " .. err)
    return
end

-- Named field access
DEFAULT_CHAT_FRAME:AddMessage("Spell: " .. row.name)  -- "Fireball"
DEFAULT_CHAT_FRAME:AddMessage("School: " .. row.school)

-- Positional access (column order)
local id, school, category = row[1], row[2], row[3]

-- French name for Fireball
local row = RQ_GetRow("Spell", 133, "frFR")
if row then
    DEFAULT_CHAT_FRAME:AddMessage(row.name)  -- French localization
end

-- All locales at once
local row = RQ_GetRow("Spell", 133, "all")
if row then
    DEFAULT_CHAT_FRAME:AddMessage(row.name_enUS)
    DEFAULT_CHAT_FRAME:AddMessage(row.name_deDE)
end

RQ_GetItemSubClass takes two arguments instead of one. The composite key is (classId, subclassId):

-- Weapon (class 2), One-Handed Axes (subclass 0)
local row, err = RQ_GetItemSubClass(2, 0)
if not row then
    DEFAULT_CHAT_FRAME:AddMessage("Reliquary: " .. err)
    return
end
DEFAULT_CHAT_FRAME:AddMessage(row.name)

Use RQ_GetRow when the DBC name is not known at write time:

local function LookupDbc(dbcName, id)
    local row, err = RQ_GetRow(dbcName, id)
    if not row then
        DEFAULT_CHAT_FRAME:AddMessage("Lookup failed: " .. err)
        return nil
    end
    return row
end

local areaRow = LookupDbc("AreaTable", 1519)  -- Stormwind City
local mapRow  = LookupDbc("Map", 0)           -- Eastern Kingdoms

1. Build Reliquary.dll (see below) or obtain a pre-built binary.
2. Copy Reliquary.dll to your TurtleWoW plugin directory alongside WoW.exe.
3. The plugin loader calls Load() on startup, which activates the Lua function hooks.

1. Install the Rust toolchain:

   https://rustup.rs
   

2. Add the 32-bit Windows target:

   rustup target add i686-pc-windows-msvc

3. Install clang-cl (C compiler) and lld-link (linker):

   # Arch / CachyOS
   sudo pacman -S clang lld
   
   # Debian / Ubuntu
   sudo apt install clang lld

4. Install xwin to obtain the MSVC sysroot:

   cargo install xwin

5. Populate the sysroot with the 32-bit (x86) libraries. Run from the repository root:

   xwin --accept-license --arch x86 splat --include-debug-libs --output xwinSDK

   If xwin is not in your PATH:

   ~/.local/share/cargo/bin/xwin --accept-license --arch x86 splat --include-debug-libs --output xwinSDK

   The --arch x86 flag is required; the default download is x86_64 only.

Use make rather than invoking cargo directly. The Makefile sets the required CC and CFLAGS environment variables with absolute paths so that the C compiler can locate the xwinSDK headers regardless of its working directory.

make          # release build (default)
make debug    # debug build

Output: target/i686-pc-windows-msvc/release/Reliquary.dll

Install the Rust toolchain and add the 32-bit Windows target:

rustup target add i686-pc-windows-msvc

With a 32-bit MSVC toolchain available (Visual Studio or the standalone Build Tools), no further configuration is needed:

cargo build --release --target i686-pc-windows-msvc