Guides
Example scripts
Choose a starter for your own Lua script.
Use Download example scripts in the Scripts tab to install the examples. Downloading does not run a script. Some examples need a logged-in character or an available game object.
Instant scripts
File under examples/instant/ | What it shows |
|---|---|
hello.lua | Logging and a minimal one-shot. |
nearby_mobs.lua | Nearby entity enumeration. |
Persistent modules
File under examples/modules/<id>/main.lua | What it shows |
|---|---|
ui_showcase | Interactive window, colors, button, checkbox, slider, input, HUD text, and F6 toggle. |
nearby_entities | Searchable, paged entity list with refresh and filtering. |
mob_overlay | Simple foreground overlay from actor records. |
block_skill | One Auto Defense watch and configured response. |
For a script of your own, start with Quickstart, copy the closest example into a new ID, then look up each call in the API reference. Check nil, error results and read game values again after a map or character change.
The quest journal and configurable travel helper are complete module examples you can save directly into your Scripts folder.