tocuto / tfm-vscode

Lua Language Server (VSCode) environment definition for Transformice

tfm-vscode

Lua Language Server environment definition for Transformice.

Usage

Configure to use MouseTool NPM repository

npm login --scope=@mousetool --registry=https://npm.pkg.github.com

> Username: Your username here
> Password: Your GitHub PAT token here
> Email: PUBLIC-EMAIL-ADDRESS

It is mandatory to set this up for the first time when dealing with MouseTool NPM packages, otherwise GitHub will deny you from installing them. More on authenticating to GitHub NPM repository can be found here.

Install for your workspace

npm install --save-dev @mousetool/tfm-vscode

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

{
    "Lua.workspace.userThirdParty": [
        "./node_modules/@mousetool/tfm-vscode"
    ]
}

If you are using .luarc.json, this would be:

{
    "workspace": {
        "userThirdParty": [
            "./node_modules/@mousetool/tfm-vscode"
        ]
    }
}

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

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-vscode.git

{
    "Lua.workspace.userThirdParty": [
        "./tfm-vscode"
    ]
}