Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

Scripting modules

Modules available to Lucent scripts.

Lucent provides focused CommonJS modules for game actions, script runtime utilities, and independent automations.

Modules

Module Description
lucent/api Perform in-game actions and inspect game state.
lucent/script Work with the current script and its runtime.
lucent/schema Validate and transform data with reusable schemas.
lucent/http Sends HTTP/HTTPS requests.
lucent/filesystem Reads and writes files in the shared Documents/Lucent/data folder.

All scripts use this folder. Paths are relative to it, such as
my-script/settings.json. Files can be up to 8 MiB, and a folder listing
can contain up to 1,000 entries.
lucent/autozone Controls automatic movement for supported encounter zones.
lucent/autorelogin Controls automatic login recovery.
effect Use the Effect utilities available to scripts.

Types

Browse referenced types for data shapes and public class surfaces.

Packages

Browse vendored script packages for shared helpers and scripts included with Lucent.

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?