API Reference

Lua API Documentation

Complete reference for VNTouch Auto scripting. 31 modules, 493 functions.

/

31

Modules

493

Functions

5.3

Lua Version

iOS 15+

Compatible

System functions: logging, sleep, time, memory, process control, clipboard, toast notifications.

OS Extensions (os)

Extensions to Lua's built-in os table. Adds script restart capability.

Touch Simulation (touch)

Touch simulation: tap, swipe, pinch, multi-touch, streaming touch events via HID.

Key Simulation (key)

Keyboard and hardware button simulation via HID events.

Screen Capture & OCR (screen)

Screen capture, color detection, template matching, OCR (Tesseract + Vision), image operations.

App Management (app)

API theo bản 1.1.248. Mở/đóng app theo Bundle ID và lấy thông tin ứng dụng/tiến trình. Backup, resto…

Device Control (device)

Device info, hardware toggles (WiFi, Bluetooth, etc.), brightness, volume, lock/unlock, vibrate.

File Operations (file)

File I/O, line operations, filesystem management, hash, zip/unzip.

Image loading, manipulation, QR code generation/decoding, and per-image color/OCR operations. Image …

HTTP Requests (http)

HTTP client: GET, POST, PUT, PATCH, DELETE, HEAD, file download with resume support.

JSON encode/decode, dot-path access, merge, search, flatten, and utility functions.

Dialogs & Notifications (dialog)

Alert dialogs, input boxes, confirmations, notifications, config persistence.

Process & IPC (proc)

Process-level shared dictionary and queue for cross-script communication.

Notification (notification)

System notifications and banners via SpringBoard tweak IPC.

Utilities (utils)

UUID, hashing, encoding, QR code, date formatting, contacts management.

Key-Value Store (store)

Persistent key-value storage that survives script restarts.

Read/write Apple property list files (XML and binary format).

Clipboard (clipboard)

Read/write system clipboard. Alias: pasteboard.

WebView (webview)

Display WKWebView overlays on any app via SpringBoard tweak. HTML, URL loading, JS evaluation.

System Cleanup (clear)

Clear caches, cookies, app data, keychain, photos, TCC permissions, Safari data.

Crane Containers (crane)

API theo bản 1.1.248. Quản lý container tweak Crane qua SpringBoard IPC; app là Bundle ID, name_or_i…

String Extensions (string)

Extensions to Lua's string library: splitting, trimming, padding, hashing (MD5/SHA1/SHA256/SHA512), …

Table Extensions (table)

Extensions to Lua's table library: deep copy, pretty print, and string loading.

Threading (thread)

Multi-threading: dispatch tasks, wait, kill, event system for cross-thread communication.

Execute shell commands via posix_spawn.

String Extensions (string.*)

Extended string functions: split, trim, hash, encrypt, encode, validate.

OS Extensions (os.*)

Script lifecycle control: exit, restart, atexit callbacks.

API theo bản 1.1.248. Quản lý clone Facebook riêng app/container/keychain, đọc đúng UID/token/cookie…

Page Manager (page)

API theo bản 1.1.248. Quản lý danh sách Page pages.db và đọc cache token theo tài khoản tại data/fb_…

AI API wrapper: gọi GPT/Claude/bất kỳ API tương thích OpenAI format.

Accessibility (ui)

Tìm, check và press phần tử của app đang ở trước qua iOS Accessibility. Có kiểm tra owner clone, ove…

Quick Start

Start automating in minutes

Write your first script using the VNTouch Lua API. Tap the screen, capture images, and run OCR — all in a few lines.

lua example.lua

-- Tap the screen and wait
touch.tap(375, 667)
sys.sleep(1.5)

-- Capture and run OCR
local text = screen.ocr_region(0, 0, 750, 200)
sys.log("Found: " .. text)

-- Find and tap an image on screen
local x, y = screen.find_image("btn_confirm.png")
if x then touch.tap(x, y) end