Defold Annotations

A set of Lua scripts for parsing Defold documentation and generating annotation files compatible with Lua Language Server.

By design, it can be run on Windows, macOS and Linux. Only Lua needs to be installed. The Lua language was chosen because it allows all Defold users to contribute to this project.

Generated annotations are available on the Releases page.

These annotations are used by Defold Kit, a Visual Studio Code extension for developing games with Defold.

Install Lua and run the main.lua script with an explicit supported Defold version (up to 1.13.1).

$ lua main.lua '1.13.1'

Do not omit the version argument: the default fetches the latest Defold release, which this generator no longer supports. You can also generate annotations for earlier versions.

$ lua main.lua '1.5.0'

As a result, you will see the tmp/defold_api folder with .lua files. These are the annotations.

The repository includes a self-contained test harness with no runtime dependency on local doc/ or generated defold_api/ folders.

Run all tests with:

$ lua tests/run.lua

The test system uses:

• tests/fixtures/docs/ for miniature synthetic Defold docs
• tests/fixtures/modules/ for direct module fixtures
• tests/fixtures/patches/ for patch-specific test data
• tests/snapshots/ for small curated output fragments

If you find a typo in the annotations or outdated meta information, please comment to issue #4. I try to collect annotation errors there, and then prepare a pull request to Defold source code, as this is the main source of documentation.

Otherwise, on parsing and generation problems, craete a new issue.

There is a launch config for tomblind/local-lua-debugger-vscode to debug with breakpoints.

It's also useful to turn the config.clean_traces to true in config.lua file to avoid deleting temporary files.

• json.lua by rxi
• htmlEntities-for-lua by Tiago Danin