tfm-lua-types

Lua Language Server environment definition for Transformice.

Requirements

The library aims to integrate with the latest versions of Lua Language Server (LLS). It should work with versions above 3.0.0, but the language server is constantly receiving updates and older versions may not support the new type checking and completion features.

Last tested LLS version: 3.13.1

Install for your workspace

Usage on VSCode

This library has been published to VSCode and can be enabled via the LLS's Addon Manager. However, it does not receive updates instantly and for this reason you may want to import the library manually, then read on below.

Import manually

npm install --save-dev tfm-lua-types

Set your VSCode workspace settings to register our third party library.

{
    "Lua.workspace.userThirdParty": [
        "./node_modules/tfm-lua-types"
    ]
}

Finally, you should be asked to load the Transformice environment after writing your code.

Alternatively, you may directly load the types as a workspace library, rather than a third party library.

{
    "Lua.workspace.library": [
+       "./node_modules/tfm-lua-types/luaLib"
    ]
}

Without NPM

You can choose to install this library using Git submodules or any inclusion methods of your choice instead. However, path to the userThirdParty has to be updated accordingly.

git submodule add https://github.com/MouseTool/tfm-types.git

{
    "Lua.workspace.userThirdParty": [
        "./tfm-types/packages/lua-types"
    ]
}