Creed Lua Scripting API

Overview

The Creed team is proud to introduce the Creed Scripting Engine, powered by a built-in Lua 5.4 runtime. Each .lua file in the scripts/ or scripts/examples/ folder is loaded automatically at startup. Scripts can be toggled on/off, reloaded live, and each runs in its own isolated Lua state.

All scripting happens through the global creed table, which provides:

• Drawing — lines, boxes, circles, triangles, and text rendered on the overlay
• Game data — entities, projectiles, player stats, camera, artillery, wind
• Projection — WorldToScreen and WorldToRadar for coordinate conversion
• Utilities — timing, math helpers, logging

Quick Start

Create a .lua file in the scripts/ folder (or scripts/examples/) with a global OnTick() function:

-- hello.lua
local WHITE = creed.Color(255, 255, 255)

function OnTick()
    creed.DrawText("Hello from Lua!", 100, 100, WHITE, 20.0)
end

That's it. The overlay picks it up automatically (or click Reload All in the Scripts tab).

Script Lifecycle

Each script goes through these stages:

1. Load — The file is read and executed once (top-level code runs here). Use this for local variable initialization and color constants.
2. OnTick() — Called every frame (~60 times/second). All drawing and data queries go here.
3. Reload — Triggered from the overlay UI. The script state is destroyed and re-created from disk.

-- Top-level: runs once on load
local counter = 0
local RED = creed.Color(255, 0, 0)

-- Called every frame
function OnTick()
    counter = counter + 1
    creed.DrawText("Frame: " .. tostring(counter), 10, 10, RED)
end

Sandbox & Safety

Scripts run in a sandboxed Lua environment. The following are not available for security:

Available standard libraries: math, string, table, utf8, coroutine, and base functions (print, pairs, ipairs, tostring, tonumber, type, select, pcall, xpcall, error, assert, next, unpack).

Drawing API

All draw functions write to the overlay's render queue. Coordinates are in screen pixels (0,0 = top-left). Colors are packed 32-bit ABGR integers created with creed.Color().

DrawLine

DrawBox / DrawFilledBox

DrawCircle / DrawFilledCircle

DrawTriangle / DrawFilledTriangle

-- Draw a filled direction arrow
local cx, cy = 200, 200
creed.DrawFilledTriangle(cx, cy - 20, cx - 10, cy + 10, cx + 10, cy + 10,
    creed.Color(255, 100, 100))

DrawText

Color

local RED        = creed.Color(255,   0,   0)           -- solid red
local SEMI_BLACK = creed.Color(  0,   0,   0, 128)      -- 50% transparent black
local GOLD       = creed.Color(255, 200,  50)           -- solid gold

ColorLerp NEW

local RED   = creed.Color(255, 0, 0)
local GREEN = creed.Color(0, 255, 0)

-- Health bar that fades from red to green
local hpFrac = player.Health / player.MaxHealth
local barColor = creed.ColorLerp(RED, GREEN, hpFrac)

Game Data

GetEntities

local entities = creed.GetEntities(20000)  -- 200m range
for _, ent in ipairs(entities) do
    if ent.IsPlayer and not ent.IsLocalPlayer then
        creed.Log(ent.ClassName .. " at " .. tostring(ent.Distance / 100) .. "m")
    end
end

GetProjectiles

GetLocalPlayer

GetLocalTeam

GetCamera

GetClosestEnemy

GetArtillery

GetWind

Utility Functions

WorldToScreen

local screen = creed.WorldToScreen(ent.Position.X, ent.Position.Y, ent.Position.Z)
if screen then
    creed.DrawText(ent.ClassName, screen.X, screen.Y, WHITE)
end

WorldToRadar NEW

local cam = creed.GetCamera()
local player = creed.GetLocalPlayer()
local dot = creed.WorldToRadar(
    ent.Position.X, ent.Position.Y,
    player.Position.X, player.Position.Y,
    cam.Rotation,
    160, 160,   -- radar center
    140,         -- radar pixel radius
    15000)       -- 150m range
creed.DrawFilledCircle(dot.X, dot.Y, 3, RED)

GetScreenSize

GetDistance

GetTime / GetDeltaTime

local offset = 0

function OnTick()
    local dt = creed.GetDeltaTime()
    offset = offset + dt * 100  -- 100 pixels per second
    creed.DrawFilledCircle(100 + offset, 100, 10, creed.Color(255, 255, 0))
end

GetFrameCount NEW

-- Blink every 30 frames
if creed.GetFrameCount() % 60 < 30 then
    creed.DrawText("WARNING", 100, 100, RED, 24)
end

Lerp / Clamp NEW

IsGameStable

Log

Config System

The config system lets scripts declare user-configurable settings that appear in the overlay UI. Users can adjust them without editing your script.

RegisterConfig

-- Declare configs at the top of your script
creed.RegisterConfig("radar_range", "slider", {
    label = "Radar Range (m)",
    default = 150,
    min = 50,
    max = 500
})

creed.RegisterConfig("show_friendlies", "toggle", {
    label = "Show Friendlies",
    default = true
})

GetConfig

function OnTick()
    local range = creed.GetConfig("radar_range") -- slider value
    local showFriends = creed.GetConfig("show_friendlies") > 0 -- toggle as bool
    -- use values...
end

Per-Script Overlay Settings

Types

Vector3

A 3D vector with arithmetic operators. Can be constructed or received from API calls.

local v = Vector3(100, 200, 300)
print(v.X, v.Y, v.Z)

-- Arithmetic
local sum  = v + Vector3(10, 0, 0)
local diff = v - Vector3(0, 10, 0)
local scaled = v * 2.0

-- Methods
local len   = v:Length()
local lenSq = v:LengthSquared()
local norm  = v:Normalize()
local d     = v:Dot(sum)
local dist  = v:Distance(sum)

EntityInfo

Returned by creed.GetEntities(). Read-only. Represents any scanned game entity.

GetBonePosition(index)

ProjectileInfo

Returned by creed.GetProjectiles(). Read-only.

PlayerStats

Returned by creed.GetLocalPlayer(). Read-only.

ArtilleryData

Returned by creed.GetArtillery(). Read-only.

WindData

Returned by creed.GetWind(). Read-only.

AimbotTarget

Returned by creed.GetClosestEnemy(). Read-only.

ProjectileType Enum

Available as a global table for comparing against ProjectileInfo.Type.

Example Scripts

Radar

A classic top-down radar that rotates with the camera. Entities appear as colored dots clamped to the radar circle.

-- radar_example.lua
local RADAR_X, RADAR_Y = 160, 160
local RADAR_RADIUS     = 140
local RADAR_RANGE      = 15000  -- 150m

local BG     = creed.Color(10, 10, 20, 180)
local BORDER = creed.Color(60, 65, 90, 200)
local ENEMY  = creed.Color(255, 60, 60, 220)
local FRIEND = creed.Color(60, 200, 60, 150)
local WHITE  = creed.Color(255, 255, 255)

function OnTick()
    creed.DrawFilledCircle(RADAR_X, RADAR_Y, RADAR_RADIUS, BG)
    creed.DrawCircle(RADAR_X, RADAR_Y, RADAR_RADIUS, BORDER, 2.0)

    local player = creed.GetLocalPlayer()
    if not player or player.MaxHealth <= 0 then return end

    local cam    = creed.GetCamera()
    local myTeam = creed.GetLocalTeam()

    for _, ent in ipairs(creed.GetEntities(RADAR_RANGE)) do
        if not ent.IsLocalPlayer then
            local dot = creed.WorldToRadar(
                ent.Position.X, ent.Position.Y,
                player.Position.X, player.Position.Y,
                cam.Rotation,
                RADAR_X, RADAR_Y, RADAR_RADIUS, RADAR_RANGE)

            local color = (ent.TeamId == myTeam) and FRIEND or ENEMY
            creed.DrawFilledCircle(dot.X, dot.Y, 3, color)
        end
    end

    creed.DrawFilledCircle(RADAR_X, RADAR_Y, 4, WHITE)
end

ESP (Extra Sensory Perception)

Draws bounding boxes, labels, and health bars over enemy entities using WorldToScreen.

-- esp_example.lua
local RED    = creed.Color(255, 50, 50, 220)
local GREEN  = creed.Color(50, 255, 50)
local YELLOW = creed.Color(255, 255, 50)

function OnTick()
    if not creed.IsGameStable() then return end
    local myTeam = creed.GetLocalTeam()

    for _, ent in ipairs(creed.GetEntities(30000)) do
        if ent.TeamId ~= myTeam and not ent.IsLocalPlayer then
            local screen = creed.WorldToScreen(
                ent.Position.X, ent.Position.Y, ent.Position.Z + 90)
            if screen then
                local dist = ent.Distance / 100
                local color = ent.IsVehicle and YELLOW or RED
                local boxH = math.max(8, 60 - dist * 0.12)
                local boxW = boxH * 0.5
                creed.DrawBox(screen.X - boxW/2, screen.Y - boxH/2, boxW, boxH, color, 1.5)
                creed.DrawText(string.format("%s %.0fm", ent.ClassName, dist),
                    screen.X - boxW/2, screen.Y + boxH/2 + 2, color, 12)

                -- Health bar
                if ent.MaxHealth > 0 then
                    local frac = creed.Clamp(ent.Health / ent.MaxHealth, 0, 1)
                    local hpColor = creed.ColorLerp(RED, GREEN, frac)
                    creed.DrawFilledBox(screen.X - boxW/2, screen.Y - boxH/2 - 4,
                        boxW * frac, 3, hpColor)
                end
            end
        end
    end
end

Artillery Helper

Displays wind info and incoming projectile warnings when operating artillery.

-- artillery_helper.lua
local INFO = creed.Color(100, 200, 255)
local WARN = creed.Color(255, 80, 80)

function OnTick()
    local arty = creed.GetArtillery()
    if not arty.IsInArtillery then return end

    local screen = creed.GetScreenSize()
    local x = screen.Width / 2 - 100
    creed.DrawText(string.format("Yaw: %.1f  Pitch: %.1f",
        arty.GunnerYaw, arty.GunnerPitch), x, 10, INFO, 16)

    local wind = creed.GetWind()
    if wind.Valid then
        creed.DrawText(string.format("Wind: %.1f m/s @ %.0f°",
            wind.WindSpeed, wind.WindAzimuth), x, 30, INFO, 14)
    end

    -- Incoming shell warning
    for _, proj in ipairs(creed.GetProjectiles(30000)) do
        if proj.IsDangerous and proj.IsIncoming then
            creed.DrawText(string.format("INCOMING %.1fs", proj.TimeToImpact),
                screen.Width / 2 - 80, screen.Height / 2 - 50, WARN, 24)
            break
        end
    end
end

Animated HUD

Shows smooth animations using GetDeltaTime, GetFrameCount, ColorLerp, and Lerp.

-- animated_hud.lua
local RED   = creed.Color(255, 60, 60)
local GREEN = creed.Color(60, 255, 60)
local WHITE = creed.Color(255, 255, 255)
local smoothHP = 1.0

function OnTick()
    local dt     = creed.GetDeltaTime()
    local player = creed.GetLocalPlayer()
    if not player or player.MaxHealth <= 0 then return end

    -- Smoothly animate health bar towards actual value
    local targetHP = creed.Clamp(player.Health / player.MaxHealth, 0, 1)
    smoothHP = creed.Lerp(smoothHP, targetHP, dt * 5.0)

    -- Color fades from red to green based on health
    local barColor = creed.ColorLerp(RED, GREEN, smoothHP)

    -- Pulsing border when low HP
    local frame = creed.GetFrameCount()
    local pulse = (math.sin(frame * 0.1) + 1) * 0.5
    local borderAlpha = smoothHP < 0.3 and (100 + pulse * 155) or 150

    local x, y, w = 20, 20, 200
    creed.DrawFilledBox(x, y, w, 16, creed.Color(0, 0, 0, 160))
    creed.DrawFilledBox(x, y, w * smoothHP, 16, barColor)
    creed.DrawBox(x, y, w, 16, creed.Color(200, 200, 200, borderAlpha), 1.0)
    creed.DrawText(string.format("HP %.0f%%", smoothHP * 100), x + 4, y + 1, WHITE, 12)
end

Quick Reference