Documentation

Script Docs

Turn a FiveM resource ZIP into a README in your browser — no AI.

Script Docs reads a FiveM resource and writes its README for you. Drop a resource ZIP or a single script, manifest, or config file, and the browser unzips it locally and scans every supported text file for commands, registered and triggered events, Lua and JS exports, export-call dependencies, fxmanifest metadata, and config files. You get four summary counters, a Detected Interfaces panel, and a live README.md preview, then export the Markdown with one click.

Everything runs client-side — your resource is unzipped and parsed in the browser with regex scanners. Nothing is sent to a server, and no tokens or credits are charged.

Accepted files

.zip.lua.js.ts.cs.json.yaml.toml.cfg.ini.md

Workflow

1Drop a file on the dropzone or use the file input — it accepts a resource .zip or a single supported script/manifest/config file. A built-in Demo Dispatch Utility loads by default.
2A ZIP is unzipped locally, filtered to supported text files, and decoded as UTF-8; a single file is read directly.
3Review the four counters: Commands, Events (registered + triggered), Exports, and Config.
4Check the Resource Summary — name, scanned file count, and script/manifest/config badges — and the Detected Interfaces panel.
5Read the live README.md preview.
6Click Export Markdown to download <resource>-README.md.

What it scans

Commands from RegisterCommand, ESX.RegisterCommand, QBCore.Commands.Add, lib.addCommand, and RegisterKeyMapping
Registered events from RegisterNetEvent, RegisterServerEvent, and AddEventHandler
Triggered events from TriggerServerEvent, TriggerClientEvent, TriggerEvent, and the latent variants
Lua exports and JS exports
Export-call dependencies — which resources your code calls into
fxmanifest.lua / __resource.lua metadata (fx_version, game, author, version), declared dependencies, and client/server/shared script lists
Config files detected by name (config, settings, shared_config, server_config, client_config, or cfg)

Export format

.md

To document a whole resource at once, zip the folder before uploading — non-ZIP uploads are one file at a time, while a single ZIP scans every supported file together.

Detection is regex- and line-based, not a full parser. It strips only single-line Lua comments, so block comments, multi-line statements, or unusual formatting can be missed, and dynamic command names only resolve when the constant is found in the scanned Lua. Treat the output as a strong starting README, not a guaranteed-complete reference.

Script Docs sits alongside The Workshop's other code tools. Pair it with PackBench when you are bundling a resource for release, or Code Smith to scan the Lua it documents for performance and security issues.

Open Script Docs and start building

Frequently asked questions

Does Script Docs cost tokens or credits?

No. Generation and export run entirely in your browser — there is no API call, server action, or billing. Uploading, scanning, and downloading the README are all free and local.

What does it output, and can I copy instead of download?

A single README.md Markdown file. You preview the full text on the page and click Export Markdown to download a .md file named after the resource with a -README.md suffix. There is no copy-to-clipboard button and no other export format.

Can I upload a whole resource, or one file at a time?

Both. Drop a single supported script, manifest, or config file, or zip the resource folder and upload the .zip — the browser unzips it locally and scans every supported text file together. Non-ZIP uploads are one file at a time, so a ZIP is the way to document a full resource at once.

Which files are read from a ZIP?

Only supported text files: .lua, .js, .mjs, .cjs, .ts, .tsx, .cs, .json, .jsonc, .yaml, .yml, .toml, .cfg, .ini, and .md. Other files, including .xml and .meta, are ignored. The ZIP parser also handles only stored and deflate-compressed entries; other compression methods are skipped.

Why are some commands or events missing from the output?

Detection is regex- and line-based after stripping single-line Lua comments, so it can miss block comments, multi-line statements, or unusual formatting. Config files are recognized by name, and dynamic command names only resolve when the constant is found in the scanned Lua. The side panel also caps each Detected Interfaces list at 8 entries, though the full set still appears in the README and counters.

Which plans include Script Docs, and is my output saved?

It is included with the Server Developer, Pro, and Studio plans. There is no server-side save — export the README to keep it, since closing the page clears the doc.

Discussion