When the tabs are not enough, write a script. DrenoxBot runs Lua scripts with its own API: events, timers, HUDs on the game screen and windows of their own. Scripts written for ZeroBot run too, without changes.

Where scripts live#

Each script is a .lua file in the scripts/ folder, next to bot.json. Sounds used by scripts go in scripts/sounds/. Inside a script, Engine.getScriptsDirectory() returns the folder's path.

The Scripting tab manages everything:

The Status column shows whether the script is running or the error that stopped it.

How a script runs#

• Each script runs on its own thread, without blocking the bot or the other scripts.
• The top-level code runs once. After that the script stays alive, receiving events and running timers.
• wait(ms) pauses the script, but events and timers keep arriving while it waits. Scripts in the while true do ... wait(100) end style work.
• An error inside an event or timer is reported and the script keeps running.
• print() goes to the Console tab as [name] text. Errors show as [lua:name] ....

Other ways to run Lua#

• Console: lua <code> runs a snippet right away, for example lua print(Player.getHealth()). The script command also manages files: script list, script on <name>, script off <name>, script reload [name], script delete <name> and script import <.lua or folder>.
• CaveBot Script waypoint: the waypoint's code runs and the route waits until it ends (no timers or events left registered). Inside it, CaveBot.GoTo("label") jumps to the label and ends the script.

The API#

Full reference, module by module: Function reference. The most used ones are below.

Functions live in tables, one per module. Positions are passed as separate x, y, z and returned as a {x, y, z} table. Inventory slots start at 1 (Enums.InventorySlot); container slots start at 0.

Events#

Register with Game.registerEvent(Game.Events.X, function) and remove with Game.unregisterEvent. Each event, with its parameters and an example, is in Game events.

Examples#

-- Target HP in a HUD on the screen
local hud = HUD.new(20, 60, "Target: -")
hud:setColor(35, 213, 255)

Game.registerEvent(Game.Events.CREATURE_HEALTH, function(id, hp)
  if id ~= Player.getTargetId() then return end
  local target = Creature.new(id)
  if target:isOnScreen() then
    hud:setText(target:getName() .. "  " .. hp .. "%")
  end
end)

-- Every 5 s: low cap shows a warning and plays scripts/sounds/alarm.wav
Timer.new("cap", function()
  local cap = Player.getCapacity()
  if cap < 100 then
    Client.showMessage("Low cap: " .. cap)
    Sound.play("alarm.wav", true)
  end
end, 5000)

-- Ctrl+F5 turns the CaveBot on and off
local ok, mods, key = HotkeyManager.parseKeyCombination("Ctrl+F5")

Game.registerEvent(Game.Events.HOTKEY_SHORTCUT_PRESS, function(k, m)
  -- bit 8 = Num Lock on: ignore it
  if k == key and bit.band(m, 7) == mods then
    local on = not Engine.isCaveBotEnabled()
    Engine.enableCaveBot(on)
    Client.showMessage("CaveBot " .. (on and "on" or "off"))
  end
end)

-- At label "check": under 50 mana potions, go to label "refill"
Game.registerEvent(Game.Events.LABEL, function(index, label)
  if label == "check" and Game.getItemCount(268) < 50 then -- 268 = mana potion
    CaveBot.GoTo("refill")
  end
  CaveBot.pause(0) -- the route waits until here
end)

-- Logs to the Console who said your name
Game.registerEvent(Game.Events.TALK, function(name, level, mode, x, y, z, text)
  if text:lower():find(Player.getName():lower(), 1, true) then
    print(name .. " (" .. level .. "): " .. text)
    Client.flashWindow()
  end
end)

Sharing and downloading scripts#

The community Downloads area has Lua scripts, cavebots and presets shared by players. From the DrenoxCommunity tab inside the game, each download has Install and Install + run, and you share your own scripts with one click. Before turning on someone else's script, read the code: it runs with your character.

Questions about a script? Post in the support forum with the code and the Console error message.