Scripting and trolling

Your first script

1. Open the client menu (Right Shift) and pick Scripts in the sidebar.
2. Press + to make a script. It's saved as config/zimandlc/scripts/script1.lua in your game folder.
3. Click into the editor, write something, press Run.

function on_load()
  print("hi " .. player.name())
end

function on_render()
  render.text("I'm alive", 20, 20)
end

A script is a plain Lua file that defines some of the callback functions. The client calls them when things happen. Everything you print shows up in the console under the editor, and so do errors.

Scripts that were running when you quit start again next time. On first launch you get hello.lua: a speed readout on the HUD, plus the K key toggles AntiAim.

The editor

Click a script in the list to open it. The green dot means it's running.

Cmd works instead of Ctrl on macOS. If you'd rather use a real editor, edit the file in config/zimandlc/scripts and press Reload. Delete asks you to press it twice, and then the file is gone.

Callbacks

Define any of these as global functions. Leave out the ones you don't need.

player

You. Every function is called with a dot: player.x(). Calling these outside a world raises not in a world, so guard with client.in_game() in on_load.

world

client

modules

Control any client module by the name shown in the menu, like "AttackAura" or "AntiAim". Setting names are also as shown, and the case doesn't matter.

modules.set_value("AntiAim", "Yaw", "Jitter")
modules.set_value("AntiAim", "Jitter Range", 120)

render

Draw on the HUD from on_render. Coordinates are window pixels from the top-left. Colors are numbers made with render.rgba. All rectangles are drawn first and all text on top of them.

theme

The client's current theme colors, ready to pass to render. Every color function takes an optional alpha from 0 to 255 (default 255), so HUDs can match whatever theme the user picked.

function on_render()
  local w, h = client.screen()
  render.rect(w / 2 - 40, h / 2 + 20, 80, 20, theme.background(200), 6)
  render.text(string.format("%.1f", player.speed()), w / 2 - 14, h / 2 + 23, theme.accent())
end

keys

Key codes to compare with on_key and client.key_down: keys.A to keys.Z, keys.N0 to keys.N9, keys.F1 to keys.F12, plus SPACE, ENTER, TAB, BACKSPACE, ESCAPE, LEFT_SHIFT, LEFT_CONTROL, LEFT_ALT, UP, DOWN, LEFT and RIGHT. Any other key works by its GLFW code.

Limits

• Each callback gets 50 ms. A loop that runs longer is stopped with took longer than 50 ms (endless loop?) so the game doesn't freeze.
• Scripts can't touch files or Java: io, os, require, dofile, debug and luajava aren't there. string, table, math, bit32 and coroutine are.
• Every script has its own globals. Two scripts can't see each other's variables.
• Everything runs on the game thread, so slow scripts cost frames.

Lua Unsafe

By default scripts cannot touch files or other scripts. The Lua Unsafe module (Misc tab, off by default) lifts that while it is on: scripts started in that state get require, dofile, loadfile, io and os. require("name") loads name.lua from the scripts folder, so scripts can share helper files. debug and luajava stay unavailable, and the 50 ms limit still applies.

Unsafe scripts can read and write any file you can and run programs, so only enable it for scripts you have read. Turning the module off stops every script that was started in unsafe mode. Clawd never starts a script that uses these functions on its own.

Examples

Coordinates in the corner

function on_render()
  local x, y, z = player.pos()
  local line = string.format("%d  %d  %d", math.floor(x), math.floor(y), math.floor(z))
  local w, h = client.screen()
  render.text(line, w - render.text_width(line) - 16, h - 30)
end

Hide chat spam

local banned = { "discord.gg", "cheap coins" }

function on_chat(text)
  for _, word in ipairs(banned) do
    if text:lower():find(word, 1, true) then return true end
  end
end

Your own anti-aim

-- a slow helicopter that nods up and down
local t = 0

function on_tick()
  t = t + 1
  player.look(t * 12, math.sin(t / 4) * 90)
end

Low health warning

local warned = false

function on_tick()
  local low = player.health() < 8
  if low and not warned then client.chat("low health, back off") end
  warned = low
end

function on_render()
  if warned then
    local w, h = client.screen()
    render.rect(0, 0, w, h, render.rgba(255, 0, 0, 40))
  end
end

CS movement modules

Source engine movement and CS anti-aim, rebuilt for Minecraft for the fun of it. Each one is a normal module: bind it, favorite it, script it.