The purpose of this project is to extract LUA documentation into .lua files that can be
imported into a project (or added to the lib path). This allows the IDE to provide
autocomplete, documentation pop-ups, and parameter hints for functions.
To easily install and configure documentation in VS Code there is an extension available: https://marketplace.visualstudio.com/items?itemName=Delwing.mudlet-scripts-sdk
- Install the Lua language server extension (extension id:
sumneko.lua) - Download mudlet-docs.zip and extract it.
- Add extracted directory to
settings.json
{
"Lua.workspace.library": [
"/path/to/extracted/lua/files/"
]
}
To build and run locally execute following command:
./gradlew bootRun